Update docs for main

Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-08-01 12:24:49 +00:00 · 2026-06-01 14:26:22 +00:00
parent e45a3ad72f
commit b0bedfc363
76 changed files with 44661 additions and 1037 deletions
--- a/main/_sources/plugins/keycloak_role.rst.txt
+++ b/main/_sources/plugins/keycloak_role.rst.txt
@@ -16,8 +16,8 @@

 .. Title

-keycloak_role -- Allows administration of Keycloak roles via Keycloak API
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+keycloak_role -- Allows administration of Keycloak roles using Keycloak API
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

 .. Collection note

@@ -35,7 +35,7 @@ keycloak_role -- Allows administration of Keycloak roles via Keycloak API

 .. rst-class:: ansible-version-added

-New in middleware\_automation.keycloak 3.4.0
+New in middleware\_automation.keycloak 3.0.0

 .. contents::
   :local:
@@ -49,9 +49,9 @@ Synopsis

 .. Description

- This module allows you to add, remove or modify Keycloak roles via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/8.0/rest\-api/index.html <https://www.keycloak.org/docs-api/8.0/rest-api/index.html>`__.
- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.
+- This module allows you to add, remove or modify Keycloak roles using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin\-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
+- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs\-api/latest/rest\-api/index.html <https://www.keycloak.org/docs-api/latest/rest-api/index.html>`__.
+- Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API.


 .. Aliases
@@ -90,7 +90,7 @@ Parameters
    </div></td>
    <td><div class="ansible-option-cell">
      <p>A dict of key/value pairs to set as custom attributes for the role.</p>
-      <p>Values may be single values (e.g. a string) or a list of strings.</p>
+      <p>Values may be single values (for example a string) or a list of strings.</p>
    </div></td>
  </tr>
  <tr class="row-odd">
@@ -189,7 +189,7 @@ Parameters
      </p>
    </div></td>
    <td><div class="ansible-option-cell">
-      <p>If the role is a client role, the client id under which it resides.</p>
+      <p>If the role is a client role, the client ID under which it resides.</p>
      <p>If this parameter is absent, the role is considered a realm role.</p>
    </div></td>
  </tr>
@@ -201,7 +201,6 @@ Parameters
      <p class="ansible-option-type-line">
        <span class="ansible-option-type">boolean</span>
      </p>
-      <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 7.1.0</em></p>
    </div></td>
    <td><div class="ansible-option-cell">
      <p>If <code class="ansible-value literal notranslate">true</code>, the role is a composition of other realm and/or client role.</p>
@@ -222,7 +221,6 @@ Parameters
        <span class="ansible-option-type">list</span>
        / <span class="ansible-option-elements">elements=dictionary</span>
      </p>
-      <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 7.1.0</em></p>
    </div></td>
    <td><div class="ansible-option-cell">
      <p>List of roles to include to the composite realm role.</p>
@@ -288,7 +286,6 @@ Parameters
      <p class="ansible-option-type-line">
        <span class="ansible-option-type">integer</span>
      </p>
-      <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.5.0</em></p>
    </div></td>
    <td><div class="ansible-option-cell">
      <p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p>
@@ -316,7 +313,6 @@ Parameters
      <p class="ansible-option-type-line">
        <span class="ansible-option-type">string</span>
      </p>
-      <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 5.4.0</em></p>
    </div></td>
    <td><div class="ansible-option-cell">
      <p>Configures the HTTP User-Agent header.</p>
@@ -353,6 +349,19 @@ Parameters
    </div></td>
  </tr>
  <tr class="row-even">
+    <td><div class="ansible-option-cell">
+      <div class="ansibleOptionAnchor" id="parameter-refresh_token"></div>
+      <p class="ansible-option-title"><strong>refresh_token</strong></p>
+      <a class="ansibleOptionLink" href="#parameter-refresh_token" title="Permalink to this option"></a>
+      <p class="ansible-option-type-line">
+        <span class="ansible-option-type">string</span>
+      </p>
+    </div></td>
+    <td><div class="ansible-option-cell">
+      <p>Authentication refresh token for Keycloak API.</p>
+    </div></td>
+  </tr>
+  <tr class="row-odd">
    <td><div class="ansible-option-cell">
      <div class="ansibleOptionAnchor" id="parameter-state"></div>
      <p class="ansible-option-title"><strong>state</strong></p>
@@ -363,8 +372,8 @@ Parameters
    </div></td>
    <td><div class="ansible-option-cell">
      <p>State of the role.</p>
-      <p>On <code class="ansible-value literal notranslate">present</code>, the role will be created if it does not yet exist, or updated with the parameters you provide.</p>
-      <p>On <code class="ansible-value literal notranslate">absent</code>, the role will be removed if it exists.</p>
+      <p>On <code class="ansible-value literal notranslate">present</code>, the role is created if it does not yet exist, or updated with the parameters you provide.</p>
+      <p>On <code class="ansible-value literal notranslate">absent</code>, the role is removed if it exists.</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-default-bold"><strong>&#34;present&#34;</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
@@ -373,7 +382,7 @@ Parameters

    </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>
@@ -381,13 +390,12 @@ Parameters
      <p class="ansible-option-type-line">
        <span class="ansible-option-type">string</span>
      </p>
-      <p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</em></p>
    </div></td>
    <td><div class="ansible-option-cell">
      <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-validate_certs"></div>
      <p class="ansible-option-title"><strong>validate_certs</strong></p>
@@ -429,6 +437,50 @@ Attributes
    - Support
    - Description

+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="attribute-action_group"></div>
+
+      .. _ansible_collections.middleware_automation.keycloak.keycloak_role_module__attribute-action_group:
+
+      .. rst-class:: ansible-option-title
+
+      **action_group**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#attribute-action_group" title="Permalink to this attribute"></a>
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      :ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak`
+
+      :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0`
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module.
+
+
+      .. raw:: html
+
+        </div>
+
+
  * - .. raw:: html

        <div class="ansible-option-cell">
@@ -533,7 +585,7 @@ Examples
        realm: MyCustomRealm
        state: present
        auth_client_id: admin-cli
-        auth_keycloak_url: https://auth.example.com/auth
+        auth_keycloak_url: https://auth.example.com
        auth_realm: master
        auth_username: USERNAME
        auth_password: PASSWORD
@@ -545,7 +597,7 @@ Examples
        realm: MyCustomRealm
        state: present
        auth_client_id: admin-cli
-        auth_keycloak_url: https://auth.example.com/auth
+        auth_keycloak_url: https://auth.example.com
        token: TOKEN
      delegate_to: localhost

@@ -556,7 +608,7 @@ Examples
        client_id: MyClient
        state: present
        auth_client_id: admin-cli
-        auth_keycloak_url: https://auth.example.com/auth
+        auth_keycloak_url: https://auth.example.com
        auth_realm: master
        auth_username: USERNAME
        auth_password: PASSWORD
@@ -567,7 +619,7 @@ Examples
        name: my-role-for-deletion
        state: absent
        auth_client_id: admin-cli
-        auth_keycloak_url: https://auth.example.com/auth
+        auth_keycloak_url: https://auth.example.com
        auth_realm: master
        auth_username: USERNAME
        auth_password: PASSWORD
@@ -576,20 +628,20 @@ Examples
    - name: Create a keycloak role with some custom attributes
      middleware_automation.keycloak.keycloak_role:
        auth_client_id: admin-cli
-        auth_keycloak_url: https://auth.example.com/auth
+        auth_keycloak_url: https://auth.example.com
        auth_realm: master
        auth_username: USERNAME
        auth_password: PASSWORD
        name: my-new-role
        attributes:
-            attrib1: value1
-            attrib2: value2
-            attrib3:
-                - with
-                - numerous
-                - individual
-                - list
-                - items
+          attrib1: value1
+          attrib2: value2
+          attrib3:
+            - with
+            - numerous
+            - individual
+            - list
+            - items
      delegate_to: localhost