internet/ansible-middleware.keycloak
3
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2026-07-25 08:55:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
1cfe2b7ca80a2b4b876c4c9783799a13f4a8f89f
ansible-middleware.keycloak/main/index.html
ansible-middleware-core b1a937142b Update docs for main 
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-23 12:27:44 +00:00

271 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to Keycloak Collection documentation &mdash; Keycloak Ansible Collection documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Ansible Collection - middleware_automation.keycloak" href="README.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
Keycloak Ansible Collection
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developing.html">Developing</a></li>
<li class="toctree-l1"><a class="reference internal" href="developing.html#contributor-s-guidelines">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/keycloak/main/">Keycloak / Red Hat Single Sign-On</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/infinispan/main/">Infinispan / Red Hat Data Grid</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/wildfly/main/">Wildfly / Red Hat JBoss EAP</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/main/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/main/">ActiveMQ / Red Hat AMQ Broker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/main/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/common/main/">Ansible Middleware utilities</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/main/">JCliff</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Keycloak Ansible Collection</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to Keycloak Collection documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-keycloak-collection-documentation">
<h1>Welcome to Keycloak Collection documentation<a class="headerlink" href="#welcome-to-keycloak-collection-documentation" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a><ul>
<li class="toctree-l2"><a class="reference internal" href="README.html#ansible-version-compatibility">Ansible version compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#support">Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#release-and-upgrade-notes">Release and Upgrade Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authentication.html">keycloak_authentication – Configure authentication in Keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authentication_flow.html">keycloak_authentication_flow – Allows administration of Keycloak authentication flows via Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authentication_required_actions.html">keycloak_authentication_required_actions – Allows administration of Keycloak authentication required actions</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authentication_v2.html">keycloak_authentication_v2 – Configure authentication flows in Keycloak in an idempotent and safe manner.</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authz_authorization_scope.html">keycloak_authz_authorization_scope – Allows administration of Keycloak client authorization scopes using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authz_custom_policy.html">keycloak_authz_custom_policy – Allows administration of Keycloak client custom Javascript policies using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authz_permission.html">keycloak_authz_permission – Allows administration of Keycloak client authorization permissions using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_authz_permission_info.html">keycloak_authz_permission_info – Query Keycloak client authorization permissions information</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_client.html">keycloak_client – Allows administration of Keycloak clients using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_client_rolemapping.html">keycloak_client_rolemapping – Allows administration of Keycloak client_rolemapping with the Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_client_rolescope.html">keycloak_client_rolescope – Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_client_scope.html">keycloak_client_scope – Allows administration of Keycloak client scopes via Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_client_scope_rolemappings.html">keycloak_client_scope_rolemappings – Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_client_scope_type.html">keycloak_client_scope_type – Set the type of a client scope in a realm or client using the Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_clientsecret_info.html">keycloak_clientsecret_info – Retrieve client secret using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_clientsecret_regenerate.html">keycloak_clientsecret_regenerate – Regenerate Keycloak client secret using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_clienttemplate.html">keycloak_clienttemplate – Allows administration of Keycloak client templates using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_component.html">keycloak_component – Allows administration of Keycloak components using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_component_info.html">keycloak_component_info – Retrieve component info in Keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_group.html">keycloak_group – Allows administration of Keycloak groups using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_identity_provider.html">keycloak_identity_provider – Allows administration of Keycloak identity providers using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_realm.html">keycloak_realm – Allows administration of Keycloak realm using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_realm_info.html">keycloak_realm_info – Allows obtaining Keycloak realm public information using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_realm_key.html">keycloak_realm_key – Allows administration of Keycloak realm keys using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_realm_keys_metadata_info.html">keycloak_realm_keys_metadata_info – Allows obtaining Keycloak realm keys metadata using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_realm_localization.html">keycloak_realm_localization – Allows management of Keycloak realm localization overrides via the Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_realm_rolemapping.html">keycloak_realm_rolemapping – Allows administration of Keycloak realm role mappings into groups with the Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_role.html">keycloak_role – Allows administration of Keycloak roles using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_user.html">keycloak_user – Create and configure a user in Keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_user_execute_actions_email.html">keycloak_user_execute_actions_email – Send a Keycloak execute-actions email to a user</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_user_federation.html">keycloak_user_federation – Allows administration of Keycloak user federations using Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_user_rolemapping.html">keycloak_user_rolemapping – Allows administration of Keycloak user_rolemapping with the Keycloak API</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/keycloak_userprofile.html">keycloak_userprofile – Allows managing Keycloak User Profiles</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="roles/keycloak.html">keycloak</a></li>
<li class="toctree-l2"><a class="reference internal" href="roles/keycloak_quarkus.html">keycloak_quarkus</a></li>
<li class="toctree-l2"><a class="reference internal" href="roles/keycloak_realm.html">keycloak_realm</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-10-devel">v3.0.10-devel</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-9">v3.0.9</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-8">v3.0.8</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-7">v3.0.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-6">v3.0.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-5">v3.0.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-4">v3.0.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-3">v3.0.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-2">v3.0.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-1">v3.0.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-0">v3.0.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-3">v2.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-2">v2.4.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-1">v2.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-0">v2.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-3-0">v2.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-2-2">v2.2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-2-1">v2.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-2-0">v2.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-1-2">v2.1.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-1-1">v2.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-1-0">v2.1.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-0-2">v2.0.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-0-1">v2.0.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-0-0">v2.0.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-3-0">v1.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-8">v1.2.8</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-7">v1.2.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-6">v1.2.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-5">v1.2.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-4">v1.2.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-1">v1.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-2-0">v1.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-1-1">v1.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-1-0">v1.1.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-7">v1.0.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-6">v1.0.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-5">v1.0.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-4">v1.0.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-3">v1.0.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-2">v1.0.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-1">v1.0.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v1-0-0">v1.0.0</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developing.html">Developing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developing.html#build-and-install-locally">Build and install locally</a></li>
<li class="toctree-l2"><a class="reference internal" href="developing.html#development-environment">Development environment</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developing.html#contributor-s-guidelines">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="testing.html#continuous-integration">Continuous integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html#test-playbooks">Test playbooks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#new-content-is-added-to-an-existing-collection">New content is added to an existing collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#new-feature-to-existing-plugin-or-role-within-a-collection-backwards-compatible">New feature to existing plugin or role within a collection (backwards compatible)</a></li>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#bug-fix-or-security-fix-to-existing-content-within-a-collection">Bug fix or security fix to existing content within a collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#breaking-change-to-any-content-within-a-collection">Breaking change to any content within a collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#content-removed-from-a-collection">Content removed from a collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#a-typographical-error-was-fixed-in-the-documentation-for-a-collection">A typographical error was fixed in the documentation for a collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#documentation-added-removed-modified-within-a-collection">Documentation added/removed/modified within a collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="releasing.html#release-automation">Release automation</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/keycloak/main/">Keycloak / Red Hat Single Sign-On</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/infinispan/main/">Infinispan / Red Hat Data Grid</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/wildfly/main/">Wildfly / Red Hat JBoss EAP</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/main/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/main/">ActiveMQ / Red Hat AMQ Broker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/main/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/common/main/">Ansible Middleware utilities</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/main/">JCliff</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="README.html" class="btn btn-neutral float-right" title="Ansible Collection - middleware_automation.keycloak" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2026, Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink