internet/ansible-middleware.keycloak
3
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2026-07-29 19:04:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for main

Browse Source 
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core
2026-07-28 13:12:36 +00:00
parent addfcea66c
commit 144fadfabe
3 changed files with 135 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
main/plugins/keycloak_realm.html
View File

@@ -1399,6 +1399,27 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-prune_undefined_realm_attributes"></div>
<div class="ansibleOptionAnchor" id="parameter-pruneUndefinedRealmAttributes"></div>
<p class="ansible-option-title"><strong>prune_undefined_realm_attributes</strong></p>
<a class="ansibleOptionLink" href="#parameter-prune_undefined_realm_attributes" title="Permalink to this option"></a>
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: pruneUndefinedRealmAttributes</span></p>
<p class="ansible-option-type-line">
<span class="ansible-option-type">boolean</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>If True all realm attributes which are not defined in the attributes dict will be deleted</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>true</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul>
</div></td>
</tr>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-quick_login_check_milli_seconds"></div>
<div class="ansibleOptionAnchor" id="parameter-quickLoginCheckMilliSeconds"></div>
@@ -1413,7 +1434,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm quick login check in milliseconds.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-realm"></div>
<p class="ansible-option-title"><strong>realm</strong></p>
@@ -1426,7 +1447,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm name.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-refresh_token"></div>
<p class="ansible-option-title"><strong>refresh_token</strong></p>
@@ -1439,7 +1460,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Authentication refresh token for Keycloak API.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-refresh_token_max_reuse"></div>
<div class="ansibleOptionAnchor" id="parameter-refreshTokenMaxReuse"></div>
@@ -1454,7 +1475,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm refresh token max reuse.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-registration_allowed"></div>
<div class="ansibleOptionAnchor" id="parameter-registrationAllowed"></div>
@@ -1475,7 +1496,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-registration_email_as_username"></div>
<div class="ansibleOptionAnchor" id="parameter-registrationEmailAsUsername"></div>
@@ -1496,7 +1517,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-registration_flow"></div>
<div class="ansibleOptionAnchor" id="parameter-registrationFlow"></div>
@@ -1511,7 +1532,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm registration flow.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-remember_me"></div>
<div class="ansibleOptionAnchor" id="parameter-rememberMe"></div>
@@ -1532,7 +1553,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-reset_credentials_flow"></div>
<div class="ansibleOptionAnchor" id="parameter-resetCredentialsFlow"></div>
@@ -1547,7 +1568,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm reset credentials flow.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-reset_password_allowed"></div>
<div class="ansibleOptionAnchor" id="parameter-resetPasswordAllowed"></div>
@@ -1568,7 +1589,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-revoke_refresh_token"></div>
<div class="ansibleOptionAnchor" id="parameter-revokeRefreshToken"></div>
@@ -1589,7 +1610,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-smtp_server"></div>
<div class="ansibleOptionAnchor" id="parameter-smtpServer"></div>
@@ -1604,7 +1625,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm smtp server.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-ssl_required"></div>
<div class="ansibleOptionAnchor" id="parameter-sslRequired"></div>
@@ -1626,7 +1647,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-sso_session_idle_timeout"></div>
<div class="ansibleOptionAnchor" id="parameter-ssoSessionIdleTimeout"></div>
@@ -1641,7 +1662,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm sso session idle timeout.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-sso_session_idle_timeout_remember_me"></div>
<div class="ansibleOptionAnchor" id="parameter-ssoSessionIdleTimeoutRememberMe"></div>
@@ -1656,7 +1677,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm sso session idle timeout remember me.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-sso_session_max_lifespan"></div>
<div class="ansibleOptionAnchor" id="parameter-ssoSessionMaxLifespan"></div>
@@ -1671,7 +1692,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm sso session max lifespan.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-sso_session_max_lifespan_remember_me"></div>
<div class="ansibleOptionAnchor" id="parameter-ssoSessionMaxLifespanRememberMe"></div>
@@ -1686,7 +1707,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm sso session max lifespan remember me.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div>
<p class="ansible-option-title"><strong>state</strong></p>
@@ -1707,7 +1728,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-supported_locales"></div>
<div class="ansibleOptionAnchor" id="parameter-supportedLocales"></div>
@@ -1723,7 +1744,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm supported locales.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-token"></div>
<p class="ansible-option-title"><strong>token</strong></p>
@@ -1736,7 +1757,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Authentication token for Keycloak API.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-user_managed_access_allowed"></div>
<div class="ansibleOptionAnchor" id="parameter-userManagedAccessAllowed"></div>
@@ -1757,7 +1778,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
<p class="ansible-option-title"><strong>validate_certs</strong></p>
@@ -1776,7 +1797,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-verify_email"></div>
<div class="ansibleOptionAnchor" id="parameter-verifyEmail"></div>
@@ -1797,7 +1818,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait_increment_seconds"></div>
<div class="ansibleOptionAnchor" id="parameter-waitIncrementSeconds"></div>
@@ -1812,7 +1833,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>The realm wait increment in seconds.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_acceptable_aaguids"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyAcceptableAaguids"></div>
@@ -1828,7 +1849,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>List of acceptable AAGUIDs for WebAuthn authenticators.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_attestation_conveyance_preference"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyAttestationConveyancePreference"></div>
@@ -1843,7 +1864,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Attestation conveyance preference for WebAuthn.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_authenticator_attachment"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyAuthenticatorAttachment"></div>
@@ -1858,7 +1879,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Authenticator attachment preference for WebAuthn authenticators.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_avoid_same_authenticator_register"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyAvoidSameAuthenticatorRegister"></div>
@@ -1879,7 +1900,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_create_timeout"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyCreateTimeout"></div>
@@ -1894,7 +1915,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Timeout for WebAuthn credential creation (ms).</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_extra_origins"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyExtraOrigins"></div>
@@ -1910,7 +1931,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Additional acceptable origins for WebAuthn requests.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_acceptable_aaguids"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessAcceptableAaguids"></div>
@@ -1926,7 +1947,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>List of acceptable AAGUIDs for WebAuthn passwordless authenticators.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_attestation_conveyance_preference"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessAttestationConveyancePreference"></div>
@@ -1941,7 +1962,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Attestation conveyance preference for WebAuthn passwordless.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_authenticator_attachment"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessAuthenticatorAttachment"></div>
@@ -1956,7 +1977,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Authenticator attachment for WebAuthn passwordless.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_avoid_same_authenticator_register"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister"></div>
@@ -1977,7 +1998,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_create_timeout"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessCreateTimeout"></div>
@@ -1992,7 +2013,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Timeout for WebAuthn passwordless credential creation (ms).</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_extra_origins"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessExtraOrigins"></div>
@@ -2008,7 +2029,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Additional acceptable origins for WebAuthn passwordless requests.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_passkeys_enabled"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessPasskeysEnabled"></div>
@@ -2029,7 +2050,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_require_resident_key"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessRequireResidentKey"></div>
@@ -2044,7 +2065,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Whether resident keys are required for WebAuthn passwordless (<code class="ansible-value literal notranslate">Yes</code>/<code class="ansible-value literal notranslate">No</code>/<code class="ansible-value literal notranslate">not specified</code>).</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_rp_entity_name"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessRpEntityName"></div>
@@ -2059,7 +2080,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>WebAuthn Passwordless Relying Party Entity Name.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_rp_id"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessRpId"></div>
@@ -2074,7 +2095,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>WebAuthn Passwordless Relying Party ID (domain).</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_signature_algorithms"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessSignatureAlgorithms"></div>
@@ -2090,7 +2111,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>List of acceptable WebAuthn signature algorithms for passwordless.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_passwordless_user_verification_requirement"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyPasswordlessUserVerificationRequirement"></div>
@@ -2105,7 +2126,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>User verification requirement for WebAuthn passwordless.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_require_resident_key"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyRequireResidentKey"></div>
@@ -2120,7 +2141,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Whether resident keys are required for WebAuthn (Yes/No/not specified).</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_rp_entity_name"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyRpEntityName"></div>
@@ -2135,7 +2156,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>WebAuthn Relying Party Entity Name.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_rp_id"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyRpId"></div>
@@ -2150,7 +2171,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>WebAuthn Relying Party ID (domain). Empty string means use request host.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_signature_algorithms"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicySignatureAlgorithms"></div>
@@ -2166,7 +2187,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>List of acceptable WebAuthn signature algorithms.</p>
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-web_authn_policy_user_verification_requirement"></div>
<div class="ansibleOptionAnchor" id="parameter-webAuthnPolicyUserVerificationRequirement"></div>