internet/ansible-middleware.keycloak
3
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2026-07-28 02:14:49 +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-06-10 13:08:36 +00:00
parent 2ab20a2f23
commit d643337bb0
45 changed files with 518 additions and 509 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
main/_sources/plugins/index.rst.txt
View File

@@ -17,8 +17,8 @@ Plugin Index
keycloak_client_rolemapping
keycloak_client_rolescope
keycloak_client_scope
keycloak_clientscope_rolemappings
keycloak_clientscope_type
keycloak_client_scope_rolemappings
keycloak_client_scope_type
keycloak_clientsecret_info
keycloak_clientsecret_regenerate
keycloak_clienttemplate

72
main/_sources/plugins/keycloak_client_rolescope.rst.txt
View File

@@ -50,7 +50,7 @@ Synopsis
.. Description
- This module allows you to add or remove Keycloak roles from clients scope 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.
- Client :ansopt:`middleware\_automation.keycloak.keycloak\_client\_rolescope#module:client\_id` must have :ansopt:`middleware\_automation.keycloak.keycloak\_client#module:full\_scope\_allowed` set to :ansval:`false`.
- Client :ansopt:`middleware\_automation.keycloak.keycloak\_client\_rolescope#module:target\_client\_id` must have :ansopt:`middleware\_automation.keycloak.keycloak\_client#module:full\_scope\_allowed` set to :ansval:`false`.
- 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.
@@ -165,34 +165,6 @@ Parameters
<p>Username to authenticate for API access with.</p>
</div></td>
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-client_id"></div>
<p class="ansible-option-title"><strong>client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
/ <span class="ansible-option-required">required</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Roles provided in <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_names"><span class="std std-ref"><span class="pre">role_names</span></span></a></strong></code> while be added to this client scope.</p>
</div></td>
</tr>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-client_scope_id"></div>
<p class="ansible-option-title"><strong>client_scope_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-client_scope_id" 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>If the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_names"><span class="std std-ref"><span class="pre">role_names</span></span></a></strong></code> are client role, the client ID under which it resides.</p>
<p>If this parameter is absent, the roles are considered a realm role.</p>
</div></td>
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div>
@@ -261,11 +233,25 @@ Parameters
</div></td>
<td><div class="ansible-option-cell">
<p>Names of roles to manipulate.</p>
<p>If <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-client_scope_id"><span class="std std-ref"><span class="pre">client_scope_id</span></span></a></strong></code> is present, all roles must be under this client.</p>
<p>If <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-client_scope_id"><span class="std std-ref"><span class="pre">client_scope_id</span></span></a></strong></code> is absent, all roles must be under the realm.</p>
<p>If <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_owner_client_id"><span class="std std-ref"><span class="pre">role_owner_client_id</span></span></a></strong></code> is present, all roles must be under this client.</p>
<p>If <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_owner_client_id"><span class="std std-ref"><span class="pre">role_owner_client_id</span></span></a></strong></code> is absent, all roles must be under the realm.</p>
</div></td>
</tr>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-role_owner_client_id"></div>
<p class="ansible-option-title"><strong>role_owner_client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-role_owner_client_id" 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>If the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_names"><span class="std std-ref"><span class="pre">role_names</span></span></a></strong></code> are client role, the client ID under which it resides.</p>
<p>If this parameter is absent, the roles are considered a realm role.</p>
</div></td>
</tr>
<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>
@@ -286,6 +272,20 @@ Parameters
</div></td>
</tr>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-target_client_id"></div>
<p class="ansible-option-title"><strong>target_client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-target_client_id" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
/ <span class="ansible-option-required">required</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Roles provided in <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_names"><span class="std std-ref"><span class="pre">role_names</span></span></a></strong></code> while be added to this client scope.</p>
</div></td>
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-token"></div>
@@ -490,8 +490,8 @@ Examples
auth_username: USERNAME
auth_password: PASSWORD
realm: MyCustomRealm
client_id: frontend-client-public
client_scope_id: backend-client-private
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- backend-role-admin
- backend-role-user
@@ -503,8 +503,8 @@ Examples
auth_username: USERNAME
auth_password: PASSWORD
realm: MyCustomRealm
client_id: frontend-client-public
client_scope_id: backend-client-private
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- backend-role-admin
state: absent
@@ -516,7 +516,7 @@ Examples
auth_username: USERNAME
auth_password: PASSWORD
realm: MyCustomRealm
client_id: frontend-client-public
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user

44
main/_sources/plugins/keycloak_clientscope_rolemappings.rst.txt → main/_sources/plugins/keycloak_client_scope_rolemappings.rst.txt
View File

@@ -10,14 +10,14 @@
.. Anchors
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_rolemappings_module:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module:
.. Anchors: short name for ansible.builtin
.. Title
keycloak_clientscope_rolemappings -- Allows administration of Keycloak clientscope scope mappings to restrict the usage of certain roles to specific clientscopes
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
keycloak_client_scope_rolemappings -- Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
@@ -29,7 +29,7 @@ keycloak_clientscope_rolemappings -- Allows administration of Keycloak clientsco
To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`.
To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_clientscope_rolemappings`.
To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client_scope_rolemappings`.
.. version_added
@@ -49,7 +49,7 @@ Synopsis
.. Description
- This module allows you to add or remove Keycloak roles from clientscopes 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, :literal:`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.
- This module allows you to add or remove Keycloak roles from client scopes 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, :literal:`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.
- 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.
@@ -180,16 +180,16 @@ Parameters
</tr>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-clientscope_id"></div>
<p class="ansible-option-title"><strong>clientscope_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-clientscope_id" title="Permalink to this option"></a>
<div class="ansibleOptionAnchor" id="parameter-client_scope_id"></div>
<p class="ansible-option-title"><strong>client_scope_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-client_scope_id" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
/ <span class="ansible-option-required">required</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Roles provided in <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_names"><span class="std std-ref"><span class="pre">role_names</span></span></a></strong></code> will be added to this clientscope.</p>
<p>Roles provided in <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-role_names"><span class="std std-ref"><span class="pre">role_names</span></span></a></strong></code> will be added to this client scope.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -345,7 +345,7 @@ Attributes
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-action_group"></div>
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_rolemappings_module__attribute-action_group:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module__attribute-action_group:
.. rst-class:: ansible-option-title
@@ -389,7 +389,7 @@ Attributes
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div>
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_rolemappings_module__attribute-check_mode:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module__attribute-check_mode:
.. rst-class:: ansible-option-title
@@ -431,7 +431,7 @@ Attributes
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div>
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_rolemappings_module__attribute-diff_mode:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_rolemappings_module__attribute-diff_mode:
.. rst-class:: ansible-option-title
@@ -482,40 +482,40 @@ Examples
.. code-block:: yaml+jinja
- name: Add roles to clientscope
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
- name: Add roles to client scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
realm: MyCustomRealm
client_id: frontend-client-public
clientscope_id: frontend-clientscope
client_scope_id: frontend-client-scope
role_names:
- backend-role-admin
- backend-role-user
- name: Remove roles from clientscope
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
- name: Remove roles from client scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
realm: MyCustomRealm
client_id: frontend-client-public
clientscope_id: frontend-clientscope
client_scope_id: frontend-client-scope
role_names:
- backend-role-admin
state: absent
- name: Add realm roles to clientscope
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
- name: Add realm roles to client scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
realm: MyCustomRealm
clientscope_id: frontend-clientscope
client_scope_id: frontend-client-scope
role_names:
- realm-role-admin
- realm-role-user
@@ -552,7 +552,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Representation of clientscope scope mappings after module execution.</p>
<p>Representation of client scope scope mappings after module execution.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> on success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">[{&#34;clientRole&#34;: false, &#34;composite&#34;: false, &#34;containerId&#34;: &#34;77f9bd4e-13a6-451e-9c72-ee6997299c1f&#34;, &#34;description&#34;: &#34;User role&#34;, &#34;id&#34;: &#34;9e155ef7-86f5-4def-b507-581ce7b87013&#34;, &#34;name&#34;: &#34;realm-role-user&#34;}, {&#34;clientRole&#34;: false, &#34;composite&#34;: false, &#34;containerId&#34;: &#34;77f9bd4e-13a6-451e-9c72-ee6997299c1f&#34;, &#34;description&#34;: &#34;Admin role&#34;, &#34;id&#34;: &#34;9e155ef7-86f5-4def-b507-581ce7b87013&#34;, &#34;name&#34;: &#34;realm-role-admin&#34;}]</code></p>
</div></td>

48
main/_sources/plugins/keycloak_clientscope_type.rst.txt → main/_sources/plugins/keycloak_client_scope_type.rst.txt
View File

@@ -10,14 +10,14 @@
.. Anchors
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_type_module:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module:
.. Anchors: short name for ansible.builtin
.. Title
keycloak_clientscope_type -- Set the type of aclientscope in realm or client using Keycloak API
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
keycloak_client_scope_type -- Set the type of a client scope in a realm or client using the Keycloak API
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
@@ -29,7 +29,7 @@ keycloak_clientscope_type -- Set the type of aclientscope in realm or client usi
To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`.
To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_clientscope_type`.
To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_client_scope_type`.
.. version_added
@@ -49,7 +49,7 @@ Synopsis
.. Description
- This module allows you to set the type (optional, default) of clientscopes 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.
- This module allows you to set the type (optional, default) of client scopes 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.
.. Aliases
@@ -175,7 +175,7 @@ Parameters
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>The <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-client_id"><span class="std std-ref"><span class="pre">client_id</span></span></a></strong></code> of the client. If not set the clientscope types are set as a default for the realm.</p>
<p>The <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-client_id"><span class="std std-ref"><span class="pre">client_id</span></span></a></strong></code> of the client. If not set the client scope types are set as a default for the realm.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -194,9 +194,9 @@ Parameters
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-default_clientscopes"></div>
<p class="ansible-option-title"><strong>default_clientscopes</strong></p>
<a class="ansibleOptionLink" href="#parameter-default_clientscopes" title="Permalink to this option"></a>
<div class="ansibleOptionAnchor" id="parameter-default_client_scopes"></div>
<p class="ansible-option-title"><strong>default_client_scopes</strong></p>
<a class="ansibleOptionLink" href="#parameter-default_client_scopes" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">list</span>
/ <span class="ansible-option-elements">elements=string</span>
@@ -222,9 +222,9 @@ Parameters
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-optional_clientscopes"></div>
<p class="ansible-option-title"><strong>optional_clientscopes</strong></p>
<a class="ansibleOptionLink" href="#parameter-optional_clientscopes" title="Permalink to this option"></a>
<div class="ansibleOptionAnchor" id="parameter-optional_client_scopes"></div>
<p class="ansible-option-title"><strong>optional_client_scopes</strong></p>
<a class="ansibleOptionLink" href="#parameter-optional_client_scopes" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">list</span>
/ <span class="ansible-option-elements">elements=string</span>
@@ -321,7 +321,7 @@ Attributes
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-action_group"></div>
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_type_module__attribute-action_group:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module__attribute-action_group:
.. rst-class:: ansible-option-title
@@ -365,7 +365,7 @@ Attributes
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div>
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_type_module__attribute-check_mode:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module__attribute-check_mode:
.. rst-class:: ansible-option-title
@@ -407,7 +407,7 @@ Attributes
<div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div>
.. _ansible_collections.middleware_automation.keycloak.keycloak_clientscope_type_module__attribute-diff_mode:
.. _ansible_collections.middleware_automation.keycloak.keycloak_client_scope_type_module__attribute-diff_mode:
.. rst-class:: ansible-option-title
@@ -459,26 +459,26 @@ Examples
.. code-block:: yaml+jinja
- name: Set default client scopes on realm level
middleware_automation.keycloak.keycloak_clientscope_type:
middleware_automation.keycloak.keycloak_client_scope_type:
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
realm: "MyCustomRealm"
default_clientscopes: ['profile', 'roles']
default_client_scopes: ['profile', 'roles']
delegate_to: localhost
- name: Set default and optional client scopes on client level with token auth
middleware_automation.keycloak.keycloak_clientscope_type:
middleware_automation.keycloak.keycloak_client_scope_type:
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
token: TOKEN
realm: "MyCustomRealm"
client_id: "MyCustomClient"
default_clientscopes: ['profile', 'roles']
optional_clientscopes: ['phone']
default_client_scopes: ['profile', 'roles']
optional_client_scopes: ['phone']
delegate_to: localhost
@@ -515,7 +515,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<p>Representation of client scopes after module execution.</p>
<p>The sample is truncated.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> on success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;default_clientscopes&#34;: [&#34;profile&#34;, &#34;role&#34;], &#34;optional_clientscopes&#34;: []}</code></p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;default_client_scopes&#34;: [&#34;profile&#34;, &#34;role&#34;], &#34;optional_client_scopes&#34;: []}</code></p>
</div></td>
</tr>
<tr class="row-odd">
@@ -530,7 +530,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<td><div class="ansible-option-cell">
<p>Representation of client scopes before module execution.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;default_clientscopes&#34;: [&#34;profile&#34;, &#34;role&#34;], &#34;optional_clientscopes&#34;: [&#34;phone&#34;]}</code></p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;default_client_scopes&#34;: [&#34;profile&#34;, &#34;role&#34;], &#34;optional_client_scopes&#34;: [&#34;phone&#34;]}</code></p>
</div></td>
</tr>
<tr class="row-even">
@@ -558,9 +558,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Representation of proposed client-scope types mapping.</p>
<p>Representation of proposed client scope types mapping.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;default_clientscopes&#34;: [&#34;profile&#34;, &#34;role&#34;], &#34;optional_clientscopes&#34;: []}</code></p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;default_client_scopes&#34;: [&#34;profile&#34;, &#34;role&#34;], &#34;optional_client_scopes&#34;: []}</code></p>
</div></td>
</tr>
</tbody>