mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-07-25 00:44:48 +00:00
865 lines
35 KiB
ReStructuredText
865 lines
35 KiB
ReStructuredText
.. Document meta
|
|
|
|
:orphan:
|
|
|
|
.. |antsibull-internal-nbsp| unicode:: 0xA0
|
|
:trim:
|
|
|
|
.. meta::
|
|
:antsibull-docs: 2.24.0
|
|
|
|
.. Anchors
|
|
|
|
.. _ansible_collections.middleware_automation.keycloak.keycloak_group_module:
|
|
|
|
.. Anchors: short name for ansible.builtin
|
|
|
|
.. Title
|
|
|
|
keycloak_group -- Allows administration of Keycloak groups using Keycloak API
|
|
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
|
|
.. Collection note
|
|
|
|
.. note::
|
|
This module is part of the `middleware_automation.keycloak collection <https://galaxy.ansible.com/ui/repo/published/middleware_automation/keycloak/>`_.
|
|
|
|
It is not included in ``ansible-core``.
|
|
To check whether it is installed, run :code:`ansible-galaxy collection list`.
|
|
|
|
To install it, use: :code:`ansible\-galaxy collection install middleware\_automation.keycloak`.
|
|
|
|
To use it in a playbook, specify: :code:`middleware_automation.keycloak.keycloak_group`.
|
|
|
|
.. version_added
|
|
|
|
.. rst-class:: ansible-version-added
|
|
|
|
New in middleware\_automation.keycloak 3.0.0
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
.. Deprecated
|
|
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. Description
|
|
|
|
- This module allows you to add, remove or modify Keycloak groups 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/20.0.2/rest\-api/index.html <https://www.keycloak.org/docs-api/20.0.2/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.
|
|
- When updating a group, where possible provide the group ID to the module. This removes a lookup to the API to translate the name into the group ID.
|
|
|
|
|
|
.. Aliases
|
|
|
|
|
|
.. Requirements
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. Options
|
|
|
|
Parameters
|
|
----------
|
|
|
|
.. raw:: html
|
|
|
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
|
<thead>
|
|
<tr class="row-odd">
|
|
<th class="head"><p>Parameter</p></th>
|
|
<th class="head"><p>Comments</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-attributes"></div>
|
|
<p class="ansible-option-title"><strong>attributes</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-attributes" title="Permalink to this option"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">dictionary</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>A dict of key/value pairs to set as custom attributes for the group.</p>
|
|
<p>Values may be single values (for example a string) or a list of strings.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_client_id"></div>
|
|
<p class="ansible-option-title"><strong>auth_client_id</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_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>OpenID Connect <em>client_id</em> to authenticate to the API with.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"admin-cli"</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_client_secret"></div>
|
|
<p class="ansible-option-title"><strong>auth_client_secret</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_client_secret" 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>Client Secret to use in conjunction with <em>auth_client_id</em> (if required).</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_keycloak_url"></div>
|
|
<div class="ansibleOptionAnchor" id="parameter-url"></div>
|
|
<p class="ansible-option-title"><strong>auth_keycloak_url</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a>
|
|
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: url</span></p>
|
|
<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>URL to the Keycloak instance.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
|
|
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
|
<p class="ansible-option-title"><strong>auth_password</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
|
|
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: password</span></p>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Password to authenticate for API access with.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_realm"></div>
|
|
<p class="ansible-option-title"><strong>auth_realm</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_realm" 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>Keycloak realm name to authenticate to for API access.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-auth_username"></div>
|
|
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
|
<p class="ansible-option-title"><strong>auth_username</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a>
|
|
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: username</span></p>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Username to authenticate for API access with.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div>
|
|
<p class="ansible-option-title"><strong>connection_timeout</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-connection_timeout" title="Permalink to this option"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">integer</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">10</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-http_agent"></div>
|
|
<p class="ansible-option-title"><strong>http_agent</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-http_agent" 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>Configures the HTTP User-Agent header.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"Ansible"</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-id"></div>
|
|
<p class="ansible-option-title"><strong>id</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-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>The unique identifier for this group.</p>
|
|
<p>This parameter is not required for updating or deleting a group but providing it reduces the number of API calls required.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-name"></div>
|
|
<p class="ansible-option-title"><strong>name</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-name" 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>Name of the group.</p>
|
|
<p>This parameter is required only when creating or updating the group.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-parents"></div>
|
|
<p class="ansible-option-title"><strong>parents</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-parents" 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=dictionary</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>List of parent groups for the group to handle sorted top to bottom.</p>
|
|
<p>Set this to create a group as a subgroup of another group or groups (parents) or when accessing an existing subgroup by name.</p>
|
|
<p>Not necessary to set when accessing an existing subgroup by its <code class='docutils literal notranslate'>ID</code> because in that case the group can be directly queried without necessarily knowing its parent(s).</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-parents/id"></div>
|
|
<p class="ansible-option-title"><strong>id</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-parents/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-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>Identify parent by ID.</p>
|
|
<p>Needs less API calls than using <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-parents/name"><span class="std std-ref"><span class="pre">parents[].name</span></span></a></strong></code>.</p>
|
|
<p>A deep parent chain can be started at any point when first given parent is given as ID.</p>
|
|
<p>Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-parents/name"></div>
|
|
<p class="ansible-option-title"><strong>name</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-parents/name" 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-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>Identify parent by name.</p>
|
|
<p>Needs more internal API calls than using <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-parents/id"><span class="std std-ref"><span class="pre">parents[].id</span></span></a></strong></code> to map names to ID's under the hood.</p>
|
|
<p>When giving a parent chain with only names it must be complete up to the top.</p>
|
|
<p>Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred.</p>
|
|
</div></td>
|
|
</tr>
|
|
|
|
<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>
|
|
<a class="ansibleOptionLink" href="#parameter-realm" 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>They Keycloak realm under which this group resides.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"master"</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<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>
|
|
<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-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-state"></div>
|
|
<p class="ansible-option-title"><strong>state</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-state" 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>State of the group.</p>
|
|
<p>On <code class="ansible-value literal notranslate">present</code>, the group 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 group is removed if it exists. Be aware that absenting a group with subgroups automatically deletes all its subgroups too.</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>"present"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"absent"</code></p></li>
|
|
</ul>
|
|
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-token"></div>
|
|
<p class="ansible-option-title"><strong>token</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-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 token for Keycloak API.</p>
|
|
</div></td>
|
|
</tr>
|
|
<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>
|
|
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">boolean</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Verify TLS certificates (do not disable this in production).</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
.. Attributes
|
|
|
|
|
|
Attributes
|
|
----------
|
|
|
|
.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}
|
|
|
|
.. list-table::
|
|
:width: 100%
|
|
:widths: auto
|
|
:header-rows: 1
|
|
:class: longtable ansible-option-table
|
|
|
|
* - Attribute
|
|
- Support
|
|
- Description
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="attribute-action_group"></div>
|
|
|
|
.. _ansible_collections.middleware_automation.keycloak.keycloak_group_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">
|
|
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div>
|
|
|
|
.. _ansible_collections.middleware_automation.keycloak.keycloak_group_module__attribute-check_mode:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**check_mode**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a>
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
Can run in :literal:`check\_mode` and return changed status prediction without modifying target.
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
* - .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div>
|
|
|
|
.. _ansible_collections.middleware_automation.keycloak.keycloak_group_module__attribute-diff_mode:
|
|
|
|
.. rst-class:: ansible-option-title
|
|
|
|
**diff_mode**
|
|
|
|
.. raw:: html
|
|
|
|
<a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a>
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
- .. raw:: html
|
|
|
|
<div class="ansible-option-cell">
|
|
|
|
Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode.
|
|
|
|
|
|
.. raw:: html
|
|
|
|
</div>
|
|
|
|
|
|
|
|
.. Notes
|
|
|
|
Notes
|
|
-----
|
|
|
|
.. note::
|
|
- Presently, the :ansretval:`middleware\_automation.keycloak.keycloak\_group#module:end\_state.realmRoles`\ , :ansretval:`middleware\_automation.keycloak.keycloak\_group#module:end\_state.clientRoles`\ , and :ansretval:`middleware\_automation.keycloak.keycloak\_group#module:end\_state.access` attributes returned by the Keycloak API are read\-only for groups. This limitation will be removed in a later version of this module.
|
|
|
|
.. Seealso
|
|
|
|
|
|
.. Examples
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: yaml+jinja
|
|
|
|
- name: Create a Keycloak group, authentication with credentials
|
|
middleware_automation.keycloak.keycloak_group:
|
|
name: my-new-kc-group
|
|
realm: MyCustomRealm
|
|
state: present
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
register: result_new_kcgrp
|
|
delegate_to: localhost
|
|
|
|
- name: Create a Keycloak group, authentication with token
|
|
middleware_automation.keycloak.keycloak_group:
|
|
name: my-new-kc-group
|
|
realm: MyCustomRealm
|
|
state: present
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
token: TOKEN
|
|
delegate_to: localhost
|
|
|
|
- name: Delete a keycloak group
|
|
middleware_automation.keycloak.keycloak_group:
|
|
id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
|
|
state: absent
|
|
realm: MyCustomRealm
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
delegate_to: localhost
|
|
|
|
- name: Delete a Keycloak group based on name
|
|
middleware_automation.keycloak.keycloak_group:
|
|
name: my-group-for-deletion
|
|
state: absent
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
delegate_to: localhost
|
|
|
|
- name: Update the name of a Keycloak group
|
|
middleware_automation.keycloak.keycloak_group:
|
|
id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
|
|
name: an-updated-kc-group-name
|
|
state: present
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
delegate_to: localhost
|
|
|
|
- name: Create a keycloak group with some custom attributes
|
|
middleware_automation.keycloak.keycloak_group:
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
name: my-new_group
|
|
attributes:
|
|
attrib1: value1
|
|
attrib2: value2
|
|
attrib3:
|
|
- with
|
|
- numerous
|
|
- individual
|
|
- list
|
|
- items
|
|
delegate_to: localhost
|
|
|
|
- name: Create a Keycloak subgroup of a base group (using parent name)
|
|
middleware_automation.keycloak.keycloak_group:
|
|
name: my-new-kc-group-sub
|
|
realm: MyCustomRealm
|
|
state: present
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
parents:
|
|
- name: my-new-kc-group
|
|
register: result_new_kcgrp_sub
|
|
delegate_to: localhost
|
|
|
|
- name: Create a Keycloak subgroup of a base group (using parent id)
|
|
middleware_automation.keycloak.keycloak_group:
|
|
name: my-new-kc-group-sub2
|
|
realm: MyCustomRealm
|
|
state: present
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
parents:
|
|
- id: "{{ result_new_kcgrp.end_state.id }}"
|
|
delegate_to: localhost
|
|
|
|
- name: Create a Keycloak subgroup of a subgroup (using parent names)
|
|
middleware_automation.keycloak.keycloak_group:
|
|
name: my-new-kc-group-sub-sub
|
|
realm: MyCustomRealm
|
|
state: present
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
parents:
|
|
- name: my-new-kc-group
|
|
- name: my-new-kc-group-sub
|
|
delegate_to: localhost
|
|
|
|
- name: Create a Keycloak subgroup of a subgroup (using direct parent id)
|
|
middleware_automation.keycloak.keycloak_group:
|
|
name: my-new-kc-group-sub-sub
|
|
realm: MyCustomRealm
|
|
state: present
|
|
auth_client_id: admin-cli
|
|
auth_keycloak_url: https://auth.example.com
|
|
auth_realm: master
|
|
auth_username: USERNAME
|
|
auth_password: PASSWORD
|
|
parents:
|
|
- id: "{{ result_new_kcgrp_sub.end_state.id }}"
|
|
delegate_to: localhost
|
|
|
|
|
|
|
|
.. Facts
|
|
|
|
|
|
.. Return values
|
|
|
|
Return Values
|
|
-------------
|
|
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
|
|
|
|
.. raw:: html
|
|
|
|
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
|
<thead>
|
|
<tr class="row-odd">
|
|
<th class="head"><p>Key</p></th>
|
|
<th class="head"><p>Description</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state"></div>
|
|
<p class="ansible-option-title"><strong>end_state</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">complex</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Representation of the group after module execution (sample is truncated).</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> on success</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/access"></div>
|
|
<p class="ansible-option-title"><strong>access</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/access" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">dictionary</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>A dict describing the accesses you have to this group based on the credentials used.</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">{"manage": true, "manageMembership": true, "view": true}</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/attributes"></div>
|
|
<p class="ansible-option-title"><strong>attributes</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/attributes" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">dictionary</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>Attributes applied to this group.</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">{"attr1": ["val1", "val2", "val3"]}</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/clientRoles"></div>
|
|
<p class="ansible-option-title"><strong>clientRoles</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/clientRoles" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">list</span>
|
|
/ <span class="ansible-option-elements">elements=string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>A list of client-level roles granted to this group.</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">[]</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/id"></div>
|
|
<p class="ansible-option-title"><strong>id</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/id" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>GUID that identifies the group.</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">"23f38145-3195-462c-97e7-97041ccea73e"</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/name"></div>
|
|
<p class="ansible-option-title"><strong>name</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/name" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>Name of the group.</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">"grp-test-123"</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/path"></div>
|
|
<p class="ansible-option-title"><strong>path</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/path" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>URI path to the group.</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">"/grp-test-123"</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/realmRoles"></div>
|
|
<p class="ansible-option-title"><strong>realmRoles</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/realmRoles" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">list</span>
|
|
/ <span class="ansible-option-elements">elements=string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>An array of the realm-level roles granted to this group.</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">[]</code></p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-end_state/subGroups"></div>
|
|
<p class="ansible-option-title"><strong>subGroups</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/subGroups" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">list</span>
|
|
/ <span class="ansible-option-elements">elements=string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
|
|
<p>A list of groups that are children of this group. These groups have the same parameters as documented here.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
|
</div></td>
|
|
</tr>
|
|
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="return-msg"></div>
|
|
<p class="ansible-option-title"><strong>msg</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a>
|
|
<p class="ansible-option-type-line">
|
|
<span class="ansible-option-type">string</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Message as to what action was taken.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
|
</div></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
.. Status (Presently only deprecated)
|
|
|
|
|
|
.. Authors
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
- Adam Goossens (@adamgoossens)
|
|
|
|
|
|
.. Extra links
|
|
|
|
|
|
.. Parsing errors
|