This changelog describes changes after version 0.2.6.
-
-
+
+
-
+
-
+
Allow to install provider jars from remote paths #303
Declared proxy_mode as deprecated, updated quarkus and realm readme #306
-
+
-
+
Internal release, documentation or test changes only.
-
+
-
+
Internal release, documentation or test changes only.
-
+
-
+
Add wait_for_port and wait_for_log systemd unit logic #199
Customize jdbc driver downloads, optional authentication #202
-
+
-
+
Internal release, documentation or test changes only.
-
+
-
+
Internal release, documentation or test changes only.
-
+
-
+
Minor enhancements, bug and documentation fixes.
-
+
-
+
This is the first stable release of the middleware_automation.keycloak collection.
diff --git a/main/README.html b/main/README.html
index 1a6f2f0..861dd5a 100644
--- a/main/README.html
+++ b/main/README.html
@@ -190,7 +190,7 @@
keycloak_client_rolemapping: manage client role mappings for users and groups.
keycloak_client_rolescope: manage client role scope mappings.
keycloak_client_scope: manage client scopes and protocol mappers (replaces community.general.keycloak_clientscope).
-keycloak_clientscope_type: manage default and optional client scope assignments.
+keycloak_client_scope_type: manage default and optional client scope assignments.
keycloak_clientsecret_info: retrieve client secret information.
keycloak_clientsecret_regenerate: regenerate a client secret.
keycloak_clienttemplate: manage legacy client templates.
diff --git a/main/_sources/CHANGELOG.rst.txt b/main/_sources/CHANGELOG.rst.txt
index dd09768..5ccb096 100644
--- a/main/_sources/CHANGELOG.rst.txt
+++ b/main/_sources/CHANGELOG.rst.txt
@@ -6,9 +6,12 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
-v3.0.8-devel
+v3.0.9-devel
============
+v3.0.8
+======
+
v3.0.7
======
diff --git a/main/_sources/README.md.txt b/main/_sources/README.md.txt
index 7ea01bb..d9ebd81 100644
--- a/main/_sources/README.md.txt
+++ b/main/_sources/README.md.txt
@@ -71,7 +71,7 @@ All Keycloak administration modules from `community.general` are provided in thi
* `keycloak_client_rolemapping`: manage client role mappings for users and groups.
* `keycloak_client_rolescope`: manage client role scope mappings.
* `keycloak_client_scope`: manage client scopes and protocol mappers (replaces `community.general.keycloak_clientscope`).
-* `keycloak_clientscope_type`: manage default and optional client scope assignments.
+* `keycloak_client_scope_type`: manage default and optional client scope assignments.
* `keycloak_clientsecret_info`: retrieve client secret information.
* `keycloak_clientsecret_regenerate`: regenerate a client secret.
* `keycloak_clienttemplate`: manage legacy client templates.
diff --git a/main/_sources/plugins/index.rst.txt b/main/_sources/plugins/index.rst.txt
index a378996..b067587 100644
--- a/main/_sources/plugins/index.rst.txt
+++ b/main/_sources/plugins/index.rst.txt
@@ -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
diff --git a/main/_sources/plugins/keycloak_client_rolescope.rst.txt b/main/_sources/plugins/keycloak_client_rolescope.rst.txt
index 7b061d1..49174f4 100644
--- a/main/_sources/plugins/keycloak_client_rolescope.rst.txt
+++ b/main/_sources/plugins/keycloak_client_rolescope.rst.txt
@@ -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
Username to authenticate for API access with.
-
-
-
- client_id
-
-
- string
- / required
-
- |
-
- Roles provided in role_names while be added to this client scope.
- |
-
-
-
-
- client_scope_id
-
-
- string
-
- |
-
- If the role_names are client role, the client ID under which it resides.
- If this parameter is absent, the roles are considered a realm role.
- |
-
@@ -261,11 +233,25 @@ Parameters
|
|
+
+
+ role_owner_client_id
+
+
+ string
+
+ |
+
+ If the role_names are client role, the client ID under which it resides.
+ If this parameter is absent, the roles are considered a realm role.
+ |
+
+
state
@@ -286,6 +272,20 @@ Parameters
|
+
+
+
+ target_client_id
+
+
+ string
+ / required
+
+ |
+
+ Roles provided in role_names while be added to this client scope.
+ |
+
@@ -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
diff --git a/main/_sources/plugins/keycloak_clientscope_rolemappings.rst.txt b/main/_sources/plugins/keycloak_client_scope_rolemappings.rst.txt
similarity index 92%
rename from main/_sources/plugins/keycloak_clientscope_rolemappings.rst.txt
rename to main/_sources/plugins/keycloak_client_scope_rolemappings.rst.txt
index aa53f82..74fb63d 100644
--- a/main/_sources/plugins/keycloak_clientscope_rolemappings.rst.txt
+++ b/main/_sources/plugins/keycloak_client_scope_rolemappings.rst.txt
@@ -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
|
-
- clientscope_id
-
+
+ client_scope_id
+
string
/ required
|
- Roles provided in role_names will be added to this clientscope.
+ Roles provided in role_names will be added to this client scope.
|
@@ -345,7 +345,7 @@ Attributes
- .. _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
- .. _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
- .. _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
`, the foll
- Representation of clientscope scope mappings after module execution.
+ Representation of client scope scope mappings after module execution.
Returned: on success
Sample: [{"clientRole": false, "composite": false, "containerId": "77f9bd4e-13a6-451e-9c72-ee6997299c1f", "description": "User role", "id": "9e155ef7-86f5-4def-b507-581ce7b87013", "name": "realm-role-user"}, {"clientRole": false, "composite": false, "containerId": "77f9bd4e-13a6-451e-9c72-ee6997299c1f", "description": "Admin role", "id": "9e155ef7-86f5-4def-b507-581ce7b87013", "name": "realm-role-admin"}]
|
diff --git a/main/_sources/plugins/keycloak_clientscope_type.rst.txt b/main/_sources/plugins/keycloak_client_scope_type.rst.txt
similarity index 91%
rename from main/_sources/plugins/keycloak_clientscope_type.rst.txt
rename to main/_sources/plugins/keycloak_client_scope_type.rst.txt
index 0350ce0..9bb4c43 100644
--- a/main/_sources/plugins/keycloak_clientscope_type.rst.txt
+++ b/main/_sources/plugins/keycloak_client_scope_type.rst.txt
@@ -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
- The client_id of the client. If not set the clientscope types are set as a default for the realm.
+ The client_id of the client. If not set the client scope types are set as a default for the realm.
|
@@ -194,9 +194,9 @@ Parameters
-
- default_clientscopes
-
+
+ default_client_scopes
+
list
/ elements=string
@@ -222,9 +222,9 @@ Parameters
|
-
- optional_clientscopes
-
+
+ optional_client_scopes
+
list
/ elements=string
@@ -321,7 +321,7 @@ Attributes
- .. _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
- .. _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
- .. _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 `, the foll
Representation of client scopes after module execution.
The sample is truncated.
Returned: on success
- Sample: {"default_clientscopes": ["profile", "role"], "optional_clientscopes": []}
+ Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": []}
|
@@ -530,7 +530,7 @@ Common return values are documented :ref:`here `, the foll
Representation of client scopes before module execution.
Returned: always
- Sample: {"default_clientscopes": ["profile", "role"], "optional_clientscopes": ["phone"]}
+ Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": ["phone"]}
|
@@ -558,9 +558,9 @@ Common return values are documented :ref:`here `, the foll
- Representation of proposed client-scope types mapping.
+ Representation of proposed client scope types mapping.
Returned: always
- Sample: {"default_clientscopes": ["profile", "role"], "optional_clientscopes": []}
+ Sample: {"default_client_scopes": ["profile", "role"], "optional_client_scopes": []}
|
diff --git a/main/index.html b/main/index.html
index 52f2cc0..c103fbf 100644
--- a/main/index.html
+++ b/main/index.html
@@ -120,8 +120,8 @@
keycloak_client_rolemapping – Allows administration of Keycloak client_rolemapping with the Keycloak API
keycloak_client_rolescope – Allows administration of Keycloak client roles scope to restrict the usage of certain roles to a other specific client applications
keycloak_client_scope – Allows administration of Keycloak client scopes via Keycloak API
-keycloak_clientscope_rolemappings – Allows administration of Keycloak clientscope scope mappings to restrict the usage of certain roles to specific clientscopes
-keycloak_clientscope_type – Set the type of aclientscope in realm or client using Keycloak API
+keycloak_client_scope_rolemappings – Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to specific client scopes
+keycloak_client_scope_type – Set the type of a client scope in a realm or client using the Keycloak API
keycloak_clientsecret_info – Retrieve client secret using Keycloak API
keycloak_clientsecret_regenerate – Regenerate Keycloak client secret using Keycloak API
keycloak_clienttemplate – Allows administration of Keycloak client templates using Keycloak API
@@ -150,7 +150,8 @@