ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-08-16 19:11:50 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

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 2024-09-26 08:36:27 +00:00
commit 8432954b31
12 changed files with 325 additions and 319 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,4 +1,3 @@
.. Document meta
:orphan:
@ -7,7 +6,7 @@
:trim:
.. meta::
:antsibull-docs: 2.12.0
:antsibull-docs: 2.14.0
.. Anchors
@ -51,7 +50,7 @@ Synopsis
.. Description
- This module allows you to add, remove or modify Keycloak roles via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles.
- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ https://www.keycloak.org/docs-api/8.0/rest-api/index.html\ .
- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs-api/8.0/rest-api/index.html <https://www.keycloak.org/docs-api/8.0/rest-api/index.html>`__.
- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.
@ -377,7 +376,7 @@ Attributes
<div class="ansible-option-cell">
Can run in \ :literal:`check\_mode`\ and return changed status prediction without modifying target.
Can run in :literal:`check\_mode` and return changed status prediction without modifying target.
.. raw:: html
@ -419,7 +418,7 @@ Attributes
<div class="ansible-option-cell">
Will return details on what has changed (or possibly needs changing in \ :literal:`check\_mode`\ ), when in diff mode.
Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode.
.. raw:: html
@ -441,7 +440,6 @@ Examples
.. code-block:: yaml+jinja
- name: Create a Keycloak realm role, authentication with credentials
middleware_automation.keycloak.keycloak_role:
name: my-new-kc-role
@ -509,7 +507,6 @@ Examples
.. Facts
@ -610,4 +607,3 @@ Authors
.. Parsing errors