ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-07-27 23:21:33 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

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 2023-10-16 13:31:06 +00:00
commit b06de7c901
13 changed files with 1468 additions and 877 deletions
Download patch file Download diff file Expand all files Collapse all files

749
main/_sources/plugins/keycloak_client.rst.txt
View file

File diff suppressed because it is too large Load diff

125
main/_sources/plugins/keycloak_role.rst.txt
View file

@ -6,23 +6,8 @@
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. role:: ansible-option-type
.. role:: ansible-option-elements
.. role:: ansible-option-required
.. role:: ansible-option-versionadded
.. role:: ansible-option-aliases
.. role:: ansible-option-choices
.. role:: ansible-option-choices-default-mark
.. role:: ansible-option-default-bold
.. role:: ansible-option-configuration
.. role:: ansible-option-returned-bold
.. role:: ansible-option-sample-bold
.. meta::
:antsibull-docs: 2.5.0
.. Anchors
@ -38,7 +23,10 @@ keycloak_role -- Allows administration of Keycloak roles via Keycloak API
.. Collection note
.. note::
This module is part of the `middleware_automation.keycloak collection <https://galaxy.ansible.com/middleware_automation/keycloak>`_.
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`.
@ -82,12 +70,13 @@ Synopsis
Parameters
----------
.. rst-class:: ansible-option-table
.. tabularcolumns:: \X{1}{3}\X{2}{3}
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
:class: longtable ansible-option-table
* - Parameter
- Comments
@ -107,9 +96,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-attributes" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
:ansible-option-type:`dictionary`
.. raw:: html
@ -143,9 +132,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_client_id" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -181,9 +170,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_client_secret" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -217,13 +206,11 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-aliases:`aliases: url`
:ansible-option-aliases:`aliases: url`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string` / :ansible-option-required:`required`
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
@ -257,13 +244,11 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-aliases:`aliases: password`
:ansible-option-aliases:`aliases: password`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -295,9 +280,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_realm" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -331,13 +316,11 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-aliases:`aliases: username`
:ansible-option-aliases:`aliases: username`
.. rst-class:: ansible-option-type-line
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -369,9 +352,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -405,9 +388,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-connection_timeout" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`integer`
:ansible-option-type:`integer`
:ansible-option-versionadded:`added in middleware\_automation.keycloak 4.5.0`
@ -446,9 +429,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -480,9 +463,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-http_agent" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
:ansible-option-versionadded:`added in middleware\_automation.keycloak 5.4.0`
@ -521,9 +504,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string` / :ansible-option-required:`required`
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
@ -557,9 +540,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-realm" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -595,9 +578,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -641,9 +624,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
:ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0`
@ -678,9 +661,9 @@ Parameters
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`boolean`
:ansible-option-type:`boolean`
.. raw:: html
@ -712,12 +695,13 @@ Parameters
Attributes
----------
.. rst-class:: ansible-option-table
.. 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
@ -899,12 +883,13 @@ Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. rst-class:: ansible-option-table
.. tabularcolumns:: \X{1}{3}\X{2}{3}
.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
:class: longtable ansible-option-table
* - Key
- Description
@ -924,9 +909,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-end_state" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
:ansible-option-type:`dictionary`
.. raw:: html
@ -969,9 +954,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-existing" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
:ansible-option-type:`dictionary`
.. raw:: html
@ -1014,9 +999,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`string`
:ansible-option-type:`string`
.. raw:: html
@ -1059,9 +1044,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
<a class="ansibleOptionLink" href="#return-proposed" title="Permalink to this return value"></a>
.. rst-class:: ansible-option-type-line
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
:ansible-option-type:`dictionary`
.. raw:: html

809
main/_sources/plugins/keycloak_user_federation.rst.txt
View file

File diff suppressed because it is too large Load diff