mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-07-28 18:34:51 +00:00
657 lines
26 KiB
ReStructuredText
657 lines
26 KiB
ReStructuredText
.. Document meta
|
|
|
|
:orphan:
|
|
|
|
.. |antsibull-internal-nbsp| unicode:: 0xA0
|
|
:trim:
|
|
|
|
.. meta::
|
|
:antsibull-docs: 2.24.0
|
|
|
|
.. Anchors
|
|
|
|
.. _ansible_collections.middleware_automation.keycloak.keycloak_component_module:
|
|
|
|
.. Anchors: short name for ansible.builtin
|
|
|
|
.. Title
|
|
|
|
keycloak_component -- Allows administration of Keycloak components 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_component`.
|
|
|
|
.. 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 the administration of Keycloak components using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the realm being used must have the requisite access rights. In a default Keycloak installation, :literal:`admin\-cli` and an :literal:`admin` user would work, as would a separate realm 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>`__. Aliases are provided so camelCased versions can be used as well.
|
|
|
|
|
|
.. 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-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-odd">
|
|
<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-even">
|
|
<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-odd">
|
|
<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-even">
|
|
<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-odd">
|
|
<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-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-config"></div>
|
|
<p class="ansible-option-title"><strong>config</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-config" 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>Configuration properties for the provider.</p>
|
|
<p>Contents vary depending on the provider type.</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-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>
|
|
/ <span class="ansible-option-required">required</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Name of the component to create.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-parent_id"></div>
|
|
<p class="ansible-option-title"><strong>parent_id</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-parent_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>The parent_id of the component. In practice the ID (name) of the realm.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-odd">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider_id"></div>
|
|
<p class="ansible-option-title"><strong>provider_id</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-provider_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>The name of the "provider ID" for the key.</p>
|
|
</div></td>
|
|
</tr>
|
|
<tr class="row-even">
|
|
<td><div class="ansible-option-cell">
|
|
<div class="ansibleOptionAnchor" id="parameter-provider_type"></div>
|
|
<p class="ansible-option-title"><strong>provider_type</strong></p>
|
|
<a class="ansibleOptionLink" href="#parameter-provider_type" 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>The name of the "provider type" for the key. That is, <code class="ansible-value literal notranslate">org.keycloak.storage.UserStorageProvider</code>, <code class="ansible-value literal notranslate">org.keycloak.userprofile.UserProfileProvider</code>, ...</p>
|
|
<p>See <a href='https://www.keycloak.org/docs/latest/server_development/index.html#_providers'>https://www.keycloak.org/docs/latest/server_development/index.html#_providers</a>.</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 Keycloak component.</p>
|
|
<p>On <code class="ansible-value literal notranslate">present</code>, the component is created (or updated if it exists already).</p>
|
|
<p>On <code class="ansible-value literal notranslate">absent</code>, the component 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>"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_component_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_component_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_component_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
|
|
|
|
|
|
.. Seealso
|
|
|
|
|
|
.. Examples
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: yaml+jinja
|
|
|
|
- name: Manage Keycloak User Storage Provider
|
|
middleware_automation.keycloak.keycloak_component:
|
|
auth_keycloak_url: http://localhost:8080
|
|
auth_username: keycloak
|
|
auth_password: keycloak
|
|
auth_realm: master
|
|
name: my storage provider
|
|
state: present
|
|
parent_id: some_realm
|
|
provider_id: my storage
|
|
provider_type: "org.keycloak.storage.UserStorageProvider"
|
|
config:
|
|
myCustomKey: "my_custom_key"
|
|
cachePolicy: "NO_CACHE"
|
|
enabled: true
|
|
|
|
|
|
|
|
.. 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">dictionary</span>
|
|
</p>
|
|
</div></td>
|
|
<td><div class="ansible-option-cell">
|
|
<p>Representation of the keycloak_component after module execution.</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/config"></div>
|
|
<p class="ansible-option-title"><strong>config</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/config" 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>Component configuration.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</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>ID of the component.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></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">"5b7ec13f-99da-46ad-8326-ab4c73cf4ce4"</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 component.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></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">"mykey"</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/parentId"></div>
|
|
<p class="ansible-option-title"><strong>parentId</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/parentId" 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>ID of the realm this key belongs to.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></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">"myrealm"</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/providerId"></div>
|
|
<p class="ansible-option-title"><strong>providerId</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/providerId" 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>The ID of the key provider.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></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">"rsa"</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/providerType"></div>
|
|
<p class="ansible-option-title"><strong>providerType</strong></p>
|
|
<a class="ansibleOptionLink" href="#return-end_state/providerType" 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>The type of provider.</p>
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code></p>
|
|
</div></td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
.. Status (Presently only deprecated)
|
|
|
|
|
|
.. Authors
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
- Björn Bösel (@fivetide)
|
|
|
|
|
|
.. Extra links
|
|
|
|
|
|
.. Parsing errors
|