mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-11-21 22:50:34 +00:00
Compare commits
62
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
15356606f3 | ||
|
|
412f3f405d | ||
|
|
e5f6f92c5d | ||
|
|
9c347d1bf0 | ||
|
|
6023cff8ca | ||
|
|
fd13175e45 | ||
|
|
c831534a48 | ||
|
|
192061d1b5 | ||
|
|
bba9d8bb23 | ||
|
|
7a1dbad76f | ||
|
|
50e1d93184 | ||
|
|
786ef844f8 | ||
|
|
8d44d73394 | ||
|
|
c8253fdbf8 | ||
|
|
9abf2e832b | ||
|
|
9e5946a2a4 | ||
|
|
ef2f24e9fc | ||
|
|
866c5e2255 | ||
|
|
a0b924b593 | ||
|
|
95c6fe1b50 | ||
|
|
9bb680b8e6 | ||
|
|
1f0a7c289f | ||
|
|
ff51c4098a | ||
|
|
f2792e32ba | ||
|
|
4f62617f2c | ||
|
|
edb38ebb3d | ||
|
|
d25bf46a6a | ||
|
|
74ca1e05ef | ||
|
|
b9181abb24 | ||
|
|
d4eafe1b30 | ||
|
|
19bd41a86a | ||
|
|
b44d754b8c | ||
|
|
404d2f6a1b | ||
|
|
bfcb125d87 | ||
|
|
1164bf008d | ||
|
|
f3353d1686 | ||
|
|
e4c3ec8046 | ||
|
|
82022b9031 | ||
|
|
0307985282 | ||
|
|
b0d1114684 | ||
|
|
728d5288ec | ||
|
|
eaeedd8d74 | ||
|
|
86a6bc63bb | ||
|
|
d557665dc9 | ||
|
|
bd82a85dea | ||
|
|
1f82f50127 | ||
|
|
adf0f7fc36 | ||
|
|
0a9e6c66eb | ||
|
|
da3d5e0ed6 | ||
|
|
f172e019b4 | ||
|
|
e764cfd6f1 | ||
|
|
01b00dfb2e | ||
|
|
1908794569 | ||
|
|
c8bcff39ef | ||
|
|
0fad56294b | ||
|
|
b2b52ddfb5 | ||
|
|
942f0ae896 | ||
|
|
92d6dddd49 | ||
|
|
a1bb84ea5b | ||
|
|
1ec94b961f | ||
|
|
ba3f716e5c | ||
|
|
808d137e4c |
@@ -38,7 +38,5 @@ skip_list:
|
||||
- vars_should_not_be_used
|
||||
- file_is_small_enough
|
||||
- file_has_valid_name
|
||||
- name[template]
|
||||
- var-naming[no-role-prefix]
|
||||
|
||||
use_default_rules: true
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule:
|
||||
# Weekly keeps Actions dependency PRs current without daily CI load.
|
||||
interval: weekly
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
# Partner Certification Checker workflow for Automation Hub requirements.
|
||||
# See: https://github.com/ansible-collections/partner-certification-checker
|
||||
name: Run collection certification checks
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
concurrency:
|
||||
group: cert-ver-${{ github.head_ref || github.run_id }}
|
||||
cancel-in-progress: true
|
||||
|
||||
# Files that are not related to the core functionality of your collection can
|
||||
# cause Ansible Lint to fail. If this happens, add an .ansible-lint file that
|
||||
# excludes those paths. See .ansible-lint in this repository.
|
||||
#
|
||||
# If there are sanity test failures that cannot be fixed, create a sanity ignore
|
||||
# file for each affected ansible-core version (for example, tests/sanity/ignore-2.18.txt).
|
||||
jobs:
|
||||
call:
|
||||
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@f182febf0568baf1151f66549401167fd10b25d2 # v4.0.0
|
||||
@@ -22,4 +22,4 @@ jobs:
|
||||
root_permission_varname: 'keycloak_install_requires_become'
|
||||
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
|
||||
molecule_tests: >-
|
||||
[ "debian", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules" ]
|
||||
[ "debian", "sso_test", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules" ]
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
name: Publish collection
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
uses: ansible-middleware/github-actions/.github/workflows/publish.yml@main
|
||||
with:
|
||||
collection_fqcn: 'middleware_automation.keycloak'
|
||||
downstream_name: 'rhbk'
|
||||
secrets:
|
||||
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
|
||||
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
|
||||
push_token: ${{ secrets.TRIGGERING_PAT }}
|
||||
|
||||
dispatch:
|
||||
needs: publish
|
||||
if: needs.publish.result == 'success'
|
||||
strategy:
|
||||
matrix:
|
||||
repo: ['ansible-middleware/ansible-middleware-ee']
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Repository Dispatch
|
||||
uses: peter-evans/repository-dispatch@v4
|
||||
with:
|
||||
token: ${{ secrets.TRIGGERING_PAT }}
|
||||
repository: ${{ matrix.repo }}
|
||||
event-type: "Dependency released - Keycloak v${{ needs.publish.outputs.tag_version }}"
|
||||
client-payload: '{ "github": ${{toJson(github)}} }'
|
||||
@@ -17,18 +17,4 @@ jobs:
|
||||
secrets:
|
||||
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
|
||||
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
|
||||
|
||||
dispatch:
|
||||
needs: release
|
||||
strategy:
|
||||
matrix:
|
||||
repo: ['ansible-middleware/ansible-middleware-ee']
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Repository Dispatch
|
||||
uses: peter-evans/repository-dispatch@v1
|
||||
with:
|
||||
token: ${{ secrets.TRIGGERING_PAT }}
|
||||
repository: ${{ matrix.repo }}
|
||||
event-type: "Dependency released - Keycloak v${{ needs.release.outputs.tag_version }}"
|
||||
client-payload: '{ "github": ${{toJson(github)}} }'
|
||||
push_token: ${{ secrets.TRIGGERING_PAT }}
|
||||
|
||||
@@ -8,7 +8,7 @@ jobs:
|
||||
traffic:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
ref: "gh-pages"
|
||||
|
||||
@@ -18,7 +18,7 @@ jobs:
|
||||
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
|
||||
|
||||
- name: Commit changes
|
||||
uses: EndBug/add-and-commit@v4
|
||||
uses: EndBug/add-and-commit@v10
|
||||
with:
|
||||
author_name: Ansible Middleware
|
||||
message: "GitHub traffic"
|
||||
|
||||
@@ -11,6 +11,9 @@ docs/_build/
|
||||
.mypy_cache/
|
||||
*.retry
|
||||
changelogs/.plugin-cache.yaml
|
||||
changelogs/fragments/*.yaml
|
||||
changelogs/fragments/*.yml
|
||||
|
||||
*.pem
|
||||
*.key
|
||||
*.p12
|
||||
|
||||
@@ -6,6 +6,46 @@ middleware\_automation.keycloak Release Notes
|
||||
|
||||
This changelog describes changes after version 0.2.6.
|
||||
|
||||
v3.0.11
|
||||
=======
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- Add certification checks to the upstream repo `#378 <https://github.com/ansible-middleware/keycloak/pull/378>`_
|
||||
- Fix cert workflow `#389 <https://github.com/ansible-middleware/keycloak/pull/389>`_
|
||||
- Fix health check URL to include HTTP relative path `#364 <https://github.com/ansible-middleware/keycloak/pull/364>`_
|
||||
- fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363 <https://github.com/ansible-middleware/keycloak/pull/363>`_
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- AMW-592 AMW Github Actions are failing because of latest molecule `#366 <https://github.com/ansible-middleware/keycloak/pull/366>`_
|
||||
- AMW-594 Upstream release is failing due to recent rules change `#373 <https://github.com/ansible-middleware/keycloak/pull/373>`_
|
||||
|
||||
v3.0.10
|
||||
=======
|
||||
|
||||
Major Changes
|
||||
-------------
|
||||
|
||||
- Fixing linting issues `#357 <https://github.com/ansible-middleware/keycloak/pull/357>`_
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 <https://github.com/ansible-middleware/keycloak/pull/356>`_
|
||||
- Fixing vars naming issue `#359 <https://github.com/ansible-middleware/keycloak/pull/359>`_
|
||||
- Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors `#358 <https://github.com/ansible-middleware/keycloak/pull/358>`_
|
||||
|
||||
v3.0.9
|
||||
======
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- AMW-551 Providing correct rhbk version `#344 <https://github.com/ansible-middleware/keycloak/pull/344>`_
|
||||
|
||||
v3.0.8
|
||||
======
|
||||
|
||||
|
||||
@@ -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.
|
||||
@@ -85,6 +85,7 @@ All Keycloak administration modules from `community.general` are provided in thi
|
||||
* `keycloak_realm_keys_metadata_info`: retrieve realm keys metadata.
|
||||
* `keycloak_realm_localization`: manage realm localization texts.
|
||||
* `keycloak_realm_rolemapping`: manage realm role mappings for users and groups.
|
||||
* `keycloak_realm_users_info`: retrieve users from a realm.
|
||||
* `keycloak_role`: manage realm and client roles.
|
||||
* `keycloak_user`: manage users (create/update/delete).
|
||||
* `keycloak_user_execute_actions_email`: trigger execute-actions emails for users.
|
||||
@@ -155,11 +156,11 @@ Note: when deploying clustered configurations, all hosts belonging to the cluste
|
||||
Execute the following command from the source root directory:
|
||||
|
||||
```bash
|
||||
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_admin_password=<changeme> -e keycloak_realm=test
|
||||
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_realm_admin_password=<changeme> -e keycloak_realm_realm=test
|
||||
```
|
||||
|
||||
- `keycloak_admin_password` password for the administration console user account.
|
||||
- `keycloak_realm` name of the realm to be created/used.
|
||||
- `keycloak_realm_admin_password` password for the administration console user account.
|
||||
- `keycloak_realm_realm` name of the realm to be created/used.
|
||||
- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost
|
||||
|
||||
```
|
||||
|
||||
@@ -6,4 +6,5 @@ python3-netaddr [platform:rpm platform:dpkg]
|
||||
python3-lxml [platform:rpm platform:dpkg]
|
||||
python3-jmespath [platform:rpm platform:dpkg]
|
||||
python3-requests [platform:rpm platform:dpkg]
|
||||
podman [platform:rpm platform:dpkg]
|
||||
|
||||
|
||||
@@ -674,6 +674,61 @@ releases:
|
||||
- 276.yaml
|
||||
- 277.yaml
|
||||
release_date: '2025-05-02'
|
||||
3.0.10:
|
||||
changes:
|
||||
major_changes:
|
||||
- 'Fixing linting issues `#357 <https://github.com/ansible-middleware/keycloak/pull/357>`_
|
||||
|
||||
'
|
||||
minor_changes:
|
||||
- 'AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 <https://github.com/ansible-middleware/keycloak/pull/356>`_
|
||||
|
||||
'
|
||||
- 'Fixing vars naming issue `#359 <https://github.com/ansible-middleware/keycloak/pull/359>`_
|
||||
|
||||
'
|
||||
- 'Removing from __future__ import annotations broke runtime type hints using
|
||||
Sequence and union syntax, causing sanity import failures and molecule module
|
||||
errors `#358 <https://github.com/ansible-middleware/keycloak/pull/358>`_
|
||||
|
||||
'
|
||||
fragments:
|
||||
- 356.yaml
|
||||
- 357.yaml
|
||||
- 358.yaml
|
||||
- 359.yaml
|
||||
release_date: '2026-06-25'
|
||||
3.0.11:
|
||||
changes:
|
||||
bugfixes:
|
||||
- 'AMW-592 AMW Github Actions are failing because of latest molecule `#366 <https://github.com/ansible-middleware/keycloak/pull/366>`_
|
||||
|
||||
'
|
||||
- 'AMW-594 Upstream release is failing due to recent rules change `#373 <https://github.com/ansible-middleware/keycloak/pull/373>`_
|
||||
|
||||
'
|
||||
minor_changes:
|
||||
- 'Add certification checks to the upstream repo `#378 <https://github.com/ansible-middleware/keycloak/pull/378>`_
|
||||
|
||||
'
|
||||
- 'Fix cert workflow `#389 <https://github.com/ansible-middleware/keycloak/pull/389>`_
|
||||
|
||||
'
|
||||
- 'Fix health check URL to include HTTP relative path `#364 <https://github.com/ansible-middleware/keycloak/pull/364>`_
|
||||
|
||||
'
|
||||
- 'fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363
|
||||
<https://github.com/ansible-middleware/keycloak/pull/363>`_
|
||||
|
||||
'
|
||||
fragments:
|
||||
- 363.yaml
|
||||
- 364.yaml
|
||||
- 366.yaml
|
||||
- 373.yaml
|
||||
- 378.yaml
|
||||
- 389.yaml
|
||||
release_date: '2026-08-24'
|
||||
3.0.2:
|
||||
changes:
|
||||
bugfixes:
|
||||
@@ -827,3 +882,12 @@ releases:
|
||||
release_date: '2026-06-01'
|
||||
3.0.8:
|
||||
release_date: '2026-06-09'
|
||||
3.0.9:
|
||||
changes:
|
||||
bugfixes:
|
||||
- 'AMW-551 Providing correct rhbk version `#344 <https://github.com/ansible-middleware/keycloak/pull/344>`_
|
||||
|
||||
'
|
||||
fragments:
|
||||
- 344.yaml
|
||||
release_date: '2026-06-11'
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
*
|
||||
!.gitignore
|
||||
@@ -44,7 +44,6 @@ extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx_antsibull_ext',
|
||||
'ansible_basic_sphinx_ext',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
# ansible_basic_sphinx_ext still imports pkg_resources (removed in setuptools 82+).
|
||||
setuptools>=70.0.0,<81.0.0
|
||||
antsibull>=0.17.0
|
||||
antsibull-docs
|
||||
antsibull-changelog
|
||||
ansible-core>=2.16.0
|
||||
ansible-pygments
|
||||
sphinx-rtd-theme
|
||||
git+https://github.com/felixfontein/ansible-basic-sphinx-ext
|
||||
myst-parser
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
namespace: middleware_automation
|
||||
name: keycloak
|
||||
version: "3.0.8"
|
||||
version: "3.0.11"
|
||||
readme: README.md
|
||||
authors:
|
||||
- Romain Pelisse <rpelisse@redhat.com>
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
v3.0.11
|
||||
=======
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- Add certification checks to the upstream repo #378
|
||||
- Fix cert workflow #389
|
||||
- Fix health check URL to include HTTP relative path #364
|
||||
- fix(keycloak_quarkus): avoid leaking maven provider password in logs #363
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- AMW-592 AMW Github Actions are failing because of latest molecule #366
|
||||
- AMW-594 Upstream release is failing due to recent rules change #373
|
||||
|
||||
+21
-2
@@ -14,8 +14,8 @@ action_groups:
|
||||
- keycloak_client_rolemapping
|
||||
- keycloak_client_rolescope
|
||||
- keycloak_client_scope
|
||||
- keycloak_clientscope_type
|
||||
- keycloak_clientscope_rolemappings
|
||||
- keycloak_client_scope_type
|
||||
- keycloak_client_scope_rolemappings
|
||||
- keycloak_clientsecret_info
|
||||
- keycloak_clientsecret_regenerate
|
||||
- keycloak_clienttemplate
|
||||
@@ -23,12 +23,15 @@ action_groups:
|
||||
- keycloak_component_info
|
||||
- keycloak_group
|
||||
- keycloak_identity_provider
|
||||
- keycloak_organization
|
||||
- keycloak_organization_info
|
||||
- keycloak_realm
|
||||
- keycloak_realm_info
|
||||
- keycloak_realm_key
|
||||
- keycloak_realm_keys_metadata_info
|
||||
- keycloak_realm_localization
|
||||
- keycloak_realm_rolemapping
|
||||
- keycloak_realm_users_info
|
||||
- keycloak_role
|
||||
- keycloak_user
|
||||
- keycloak_user_federation
|
||||
@@ -44,3 +47,19 @@ plugin_routing:
|
||||
warning_text: >-
|
||||
The module has been renamed to keycloak_client_scope for Keycloak 17+ (Quarkus).
|
||||
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope.
|
||||
|
||||
keycloak_clientscope_type:
|
||||
redirect: middleware_automation.keycloak.keycloak_client_scope_type
|
||||
deprecation:
|
||||
removal_version: 5.0.0
|
||||
warning_text: >-
|
||||
The module has been renamed to keycloak_client_scope_type for Keycloak 17+ (Quarkus).
|
||||
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_type.
|
||||
|
||||
keycloak_clientscope_rolemappings:
|
||||
redirect: middleware_automation.keycloak.keycloak_client_scope_rolemappings
|
||||
deprecation:
|
||||
removal_version: 5.0.0
|
||||
warning_text: >-
|
||||
The module has been renamed to keycloak_client_scope_rolemappings for Keycloak 17+ (Quarkus).
|
||||
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_rolemappings.
|
||||
|
||||
@@ -14,32 +14,32 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_users:
|
||||
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
attributes:
|
||||
post.logout.redirect.uris: '/public/logout'
|
||||
|
||||
@@ -6,7 +6,7 @@ platforms:
|
||||
image: ghcr.io/hspaans/molecule-containers:debian-13
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -19,30 +19,30 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_users:
|
||||
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -20,8 +20,51 @@
|
||||
|
||||
- name: Download keycloak archive to controller directory
|
||||
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
|
||||
url: https://github.com/keycloak/keycloak/releases/download/26.4.7/keycloak-26.4.7.zip
|
||||
url: https://github.com/keycloak/keycloak/releases/download/26.6.2/keycloak-26.6.2.zip
|
||||
dest: /tmp/keycloak
|
||||
mode: '0640'
|
||||
validate_certs: false
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
ignore_errors: true
|
||||
|
||||
- name: Attempt RHBK download using redhat.runtimes_common collection
|
||||
when:
|
||||
- rhn_username is defined
|
||||
- rhn_username | length > 0
|
||||
block:
|
||||
- name: Retrieve RHBK product download using Unified Downloads API
|
||||
middleware_automation.common.product_search:
|
||||
client_id: "{{ rhn_username }}"
|
||||
client_secret: "{{ rhn_password }}"
|
||||
product_type: DISTRIBUTION
|
||||
product_version: "{{ keycloak_quarkus_version | default('26.6.2') }}"
|
||||
product_category: "RHBK"
|
||||
register: rhn_products
|
||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
ignore_errors: true
|
||||
|
||||
- name: Determine install zipfile from search results
|
||||
ansible.builtin.set_fact:
|
||||
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.6.2')) + '.zip$') }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
when:
|
||||
- rhn_products is defined
|
||||
- rhn_products.results is defined
|
||||
|
||||
- name: Download Red Hat Build of Keycloak
|
||||
middleware_automation.common.product_download:
|
||||
client_id: "{{ rhn_username }}"
|
||||
client_secret: "{{ rhn_password }}"
|
||||
product_id: "{{ (rhn_matched_products | first).id }}"
|
||||
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.6.2') }}.zip"
|
||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
when:
|
||||
- rhn_matched_products is defined
|
||||
- rhn_matched_products | length > 0
|
||||
ignore_errors: true
|
||||
|
||||
@@ -1,4 +1,9 @@
|
||||
---
|
||||
keycloak_download_validate_certs: false
|
||||
keycloak_validate_certs: false
|
||||
keycloak_quarkus_download_validate_certs: false
|
||||
keycloak_quarkus_validate_certs: false
|
||||
keycloak_realm_validate_certs: false
|
||||
keycloak_quarkus_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
||||
keycloak_quarkus_systemd_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
||||
keycloak_quarkus_install_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
|
||||
|
||||
@@ -7,12 +7,11 @@
|
||||
keycloak_quarkus_show_deprecation_warnings: false
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||
keycloak_quarkus_hostname: https://proxy
|
||||
keycloak_quarkus_hostname: "http://proxy:{{ keycloak_quarkus_http_port }}"
|
||||
keycloak_quarkus_log: file
|
||||
keycloak_quarkus_http_enabled: True
|
||||
keycloak_quarkus_http_port: 8080
|
||||
keycloak_quarkus_proxy_mode: edge
|
||||
keycloak_quarkus_http_relative_path: /
|
||||
keycloak_quarkus_health_check_url: http://proxy:8080/realms/master/.well-known/openid-configuration
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
|
||||
@@ -9,7 +9,7 @@ platforms:
|
||||
command: "/usr/sbin/init"
|
||||
networks:
|
||||
- name: keycloak
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
published_ports:
|
||||
- 0.0.0.0:8080:8080/tcp
|
||||
@@ -20,7 +20,7 @@ platforms:
|
||||
command: "/usr/sbin/init"
|
||||
networks:
|
||||
- name: keycloak
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "443/tcp"
|
||||
published_ports:
|
||||
- 0.0.0.0:443:443/tcp
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -37,8 +37,8 @@
|
||||
- keycloak_client_rolemapping
|
||||
- keycloak_client_rolescope
|
||||
- keycloak_client_scope
|
||||
- keycloak_clientscope_type
|
||||
- keycloak_clientscope_rolemappings
|
||||
- keycloak_client_scope_type
|
||||
- keycloak_client_scope_rolemappings
|
||||
- keycloak_clientsecret_info
|
||||
- keycloak_clientsecret_regenerate
|
||||
- keycloak_clienttemplate
|
||||
@@ -46,12 +46,15 @@
|
||||
- keycloak_component_info
|
||||
- keycloak_group
|
||||
- keycloak_identity_provider
|
||||
- keycloak_organization
|
||||
- keycloak_organization_info
|
||||
- keycloak_realm
|
||||
- keycloak_realm_info
|
||||
- keycloak_realm_key
|
||||
- keycloak_realm_keys_metadata_info
|
||||
- keycloak_realm_localization
|
||||
- keycloak_realm_rolemapping
|
||||
- keycloak_realm_users_info
|
||||
- keycloak_role
|
||||
- keycloak_user
|
||||
- keycloak_user_execute_actions_email
|
||||
@@ -90,6 +93,7 @@
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
block:
|
||||
- name: Reset fixtures from a previous verify run
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
@@ -168,6 +172,7 @@
|
||||
middleware_automation.keycloak.keycloak_realm_info:
|
||||
auth_keycloak_url: "{{ auth_keycloak_url }}"
|
||||
realm: "{{ target_realm }}"
|
||||
validate_certs: false
|
||||
|
||||
- name: Exercise migrated modules against running Keycloak
|
||||
module_defaults:
|
||||
@@ -176,6 +181,7 @@
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
block:
|
||||
- name: keycloak_realm_keys_metadata_info — query realm keys
|
||||
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
|
||||
@@ -185,6 +191,18 @@
|
||||
middleware_automation.keycloak.keycloak_component_info:
|
||||
realm: "{{ target_realm }}"
|
||||
|
||||
- name: keycloak_realm_users_info — list users in realm
|
||||
middleware_automation.keycloak.keycloak_realm_users_info:
|
||||
realm: "{{ target_realm }}"
|
||||
register: realm_users_info_result
|
||||
|
||||
- name: Assert keycloak_realm_users_info returns the molecule user
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- realm_users_info_result is not changed
|
||||
- realm_users_info_result.users | length > 0
|
||||
- realm_users_info_result.users | selectattr('username', 'equalto', user) | list | length == 1
|
||||
|
||||
- name: keycloak_realm — create ephemeral realm
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ ephemeral_realm }}"
|
||||
@@ -192,6 +210,213 @@
|
||||
enabled: true
|
||||
state: present
|
||||
|
||||
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 1 - Introduce custom realm attributes
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ ephemeral_realm }}"
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
enabled: true
|
||||
state: present
|
||||
prune_undefined_realm_attributes: false
|
||||
attributes:
|
||||
custom-realm-attribute-1: 123
|
||||
custom-realm-attribute-2: true
|
||||
register: custom_realm_attributes_result
|
||||
|
||||
- name: Assert realm attribute without pruning undefined data result (Step 1)
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- custom_realm_attributes_result is changed
|
||||
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123"
|
||||
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "true"
|
||||
|
||||
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 2 - Verify unchanged custom realm attributes
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ ephemeral_realm }}"
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
enabled: true
|
||||
state: present
|
||||
prune_undefined_realm_attributes: false
|
||||
attributes:
|
||||
custom-realm-attribute-2: false
|
||||
register: custom_realm_attributes_result
|
||||
|
||||
- name: Assert realm attribute without pruning undefined data result (Step 2)
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- custom_realm_attributes_result is changed
|
||||
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123" # should still be 123
|
||||
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "false"
|
||||
|
||||
- name: keycloak_realm — modify realm attributes with pruning undefined attributes
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ ephemeral_realm }}"
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
enabled: true
|
||||
state: present
|
||||
prune_undefined_realm_attributes: true
|
||||
attributes:
|
||||
custom-realm-attribute-3: custom-attribute-3
|
||||
register: custom_realm_attributes_result
|
||||
|
||||
- name: Assert realm attribute with pruning undefined data result
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- custom_realm_attributes_result is changed
|
||||
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] is not defined
|
||||
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] is not defined
|
||||
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-3"] == "custom-attribute-3"
|
||||
|
||||
# --- Organization module tests ---
|
||||
|
||||
- name: keycloak_realm — enable organizations on ephemeral realm
|
||||
middleware_automation.keycloak.keycloak_realm:
|
||||
id: "{{ ephemeral_realm }}"
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
organizations_enabled: true
|
||||
state: present
|
||||
|
||||
- name: keycloak_organization — create organization
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org
|
||||
description: Molecule test organization
|
||||
enabled: true
|
||||
domains:
|
||||
- name: molecule.example.com
|
||||
state: present
|
||||
register: org_create_result
|
||||
|
||||
- name: Assert organization was created
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_create_result is changed
|
||||
- org_create_result.end_state.name == "molecule-org"
|
||||
- org_create_result.end_state.description == "Molecule test organization"
|
||||
- org_create_result.end_state.enabled == true
|
||||
- org_create_result.end_state.id is defined
|
||||
|
||||
- name: keycloak_organization — create organization (idempotency)
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org
|
||||
description: Molecule test organization
|
||||
enabled: true
|
||||
domains:
|
||||
- name: molecule.example.com
|
||||
state: present
|
||||
register: org_create_idempotent_result
|
||||
|
||||
- name: Assert organization creation is idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_create_idempotent_result is not changed
|
||||
|
||||
- name: keycloak_organization — update organization description
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org
|
||||
description: Updated molecule test organization
|
||||
state: present
|
||||
register: org_update_result
|
||||
|
||||
- name: Assert organization was updated
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_update_result is changed
|
||||
- org_update_result.end_state.description == "Updated molecule test organization"
|
||||
|
||||
- name: keycloak_organization — update organization (idempotency)
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org
|
||||
description: Updated molecule test organization
|
||||
state: present
|
||||
register: org_update_idempotent_result
|
||||
|
||||
- name: Assert organization update is idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_update_idempotent_result is not changed
|
||||
|
||||
- name: keycloak_organization_info — query organization by name
|
||||
middleware_automation.keycloak.keycloak_organization_info:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org
|
||||
register: org_info_result
|
||||
|
||||
- name: Assert organization info returns the created org
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_info_result is not changed
|
||||
- org_info_result.organizations | length == 1
|
||||
- org_info_result.organizations[0].name == "molecule-org"
|
||||
|
||||
- name: keycloak_organization_info — list all organizations
|
||||
middleware_automation.keycloak.keycloak_organization_info:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
register: org_info_all_result
|
||||
|
||||
- name: Assert organization list is non-empty
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_info_all_result.organizations | length >= 1
|
||||
|
||||
- name: keycloak_organization — create organization with attributes
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org-attrs
|
||||
description: Organization with attributes
|
||||
attributes:
|
||||
department: engineering
|
||||
tags:
|
||||
- test
|
||||
- molecule
|
||||
state: present
|
||||
register: org_attrs_result
|
||||
|
||||
- name: Assert organization with attributes was created
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_attrs_result is changed
|
||||
- org_attrs_result.end_state.attributes.department == ["engineering"]
|
||||
- org_attrs_result.end_state.attributes.tags == ["test", "molecule"]
|
||||
|
||||
- name: keycloak_organization — delete organization with attributes
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org-attrs
|
||||
state: absent
|
||||
register: org_attrs_delete_result
|
||||
|
||||
- name: Assert organization with attributes was deleted
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_attrs_delete_result is changed
|
||||
|
||||
- name: keycloak_organization — delete organization
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org
|
||||
state: absent
|
||||
register: org_delete_result
|
||||
|
||||
- name: Assert organization was deleted
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_delete_result is changed
|
||||
|
||||
- name: keycloak_organization — delete organization (idempotency)
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
realm: "{{ ephemeral_realm }}"
|
||||
name: molecule-org
|
||||
state: absent
|
||||
register: org_delete_idempotent_result
|
||||
|
||||
- name: Assert organization deletion is idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- org_delete_idempotent_result is not changed
|
||||
|
||||
- name: keycloak_realm_localization — set locale override
|
||||
middleware_automation.keycloak.keycloak_realm_localization:
|
||||
parent_id: "{{ target_realm }}"
|
||||
@@ -253,6 +478,50 @@
|
||||
clientId: molecule-idp-client
|
||||
state: present
|
||||
|
||||
- name: keycloak_identity_provider — set hide_on_login via top-level param
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
hide_on_login: true
|
||||
state: present
|
||||
register: idp_hide_on_login_result
|
||||
|
||||
- name: Assert hide_on_login is set correctly in end_state
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- idp_hide_on_login_result is changed
|
||||
- idp_hide_on_login_result.end_state.hideOnLogin == true
|
||||
- "'hide_on_login' not in (idp_hide_on_login_result.end_state.config | default({}))"
|
||||
|
||||
- name: keycloak_identity_provider — set hide_on_login idempotency check
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
hide_on_login: true
|
||||
state: present
|
||||
register: idp_hide_on_login_idempotent_result
|
||||
|
||||
- name: Assert hide_on_login idempotency (no change)
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- idp_hide_on_login_idempotent_result is not changed
|
||||
- idp_hide_on_login_idempotent_result.end_state.hideOnLogin == true
|
||||
|
||||
- name: keycloak_identity_provider — set hide_on_login via legacy config key (backward compat)
|
||||
middleware_automation.keycloak.keycloak_identity_provider:
|
||||
realm: "{{ target_realm }}"
|
||||
alias: "{{ idp }}"
|
||||
hide_on_login: false
|
||||
state: present
|
||||
register: idp_hide_on_login_off_result
|
||||
|
||||
- name: Assert hide_on_login can be toggled off via top-level param
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- idp_hide_on_login_off_result is changed
|
||||
- idp_hide_on_login_off_result.end_state.hideOnLogin == false
|
||||
- "'hide_on_login_page' not in (idp_hide_on_login_off_result.end_state.config | default({}))"
|
||||
|
||||
- name: keycloak_clienttemplate — create client template
|
||||
middleware_automation.keycloak.keycloak_clienttemplate:
|
||||
realm: "{{ target_realm }}"
|
||||
@@ -265,10 +534,10 @@
|
||||
- "'404' not in (clienttemplate_result.msg | default(''))"
|
||||
- "'Not Found' not in (clienttemplate_result.msg | default(''))"
|
||||
|
||||
- name: keycloak_clientscope_type — attach scope as optional on realm
|
||||
middleware_automation.keycloak.keycloak_clientscope_type:
|
||||
- name: keycloak_client_scope_type — attach scope as optional on realm
|
||||
middleware_automation.keycloak.keycloak_client_scope_type:
|
||||
realm: "{{ target_realm }}"
|
||||
optional_clientscopes:
|
||||
optional_client_scopes:
|
||||
- "{{ scope }}"
|
||||
|
||||
- name: keycloak_user_rolemapping — assign realm role to user
|
||||
@@ -299,54 +568,54 @@
|
||||
- name: keycloak_client_rolescope — restrict realm role on client
|
||||
middleware_automation.keycloak.keycloak_client_rolescope:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
target_client_id: "{{ client }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
state: present
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — map client roles to clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — map client roles to client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ client_role }}"
|
||||
register: clientscope_rolemappings_result
|
||||
register: client_scope_rolemappings_result
|
||||
|
||||
- name: Assert clientscope role mappings were created
|
||||
- name: Assert client scope role mappings were created
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- clientscope_rolemappings_result is changed
|
||||
- clientscope_rolemappings_result.end_state | length == 1
|
||||
- client_scope_rolemappings_result is changed
|
||||
- client_scope_rolemappings_result.end_state | length == 1
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — remap client role (idempotency)
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — remap client role (idempotency)
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ client_role }}"
|
||||
register: clientscope_rolemappings_idempotent_result
|
||||
register: client_scope_rolemappings_idempotent_result
|
||||
|
||||
- name: Assert clientscope role mappings are idempotent
|
||||
- name: Assert client scope role mappings are idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- clientscope_rolemappings_idempotent_result is not changed
|
||||
- clientscope_rolemappings_idempotent_result.end_state | length == 1
|
||||
- client_scope_rolemappings_idempotent_result is not changed
|
||||
- client_scope_rolemappings_idempotent_result.end_state | length == 1
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — map realm role to clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — map realm role to client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
register: clientscope_realm_rolemappings_result
|
||||
register: client_scope_realm_rolemappings_result
|
||||
|
||||
- name: Assert realm role was mapped to clientscope
|
||||
- name: Assert realm role was mapped to client_scope
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- clientscope_realm_rolemappings_result is changed
|
||||
- clientscope_realm_rolemappings_result.end_state | length == 1
|
||||
- client_scope_realm_rolemappings_result is changed
|
||||
- client_scope_realm_rolemappings_result.end_state | length == 1
|
||||
|
||||
- name: keycloak_user — set email_verified explicitly
|
||||
middleware_automation.keycloak.keycloak_user:
|
||||
@@ -492,6 +761,7 @@
|
||||
auth_realm: "{{ auth_realm }}"
|
||||
auth_username: "{{ auth_username }}"
|
||||
auth_password: "{{ auth_password }}"
|
||||
validate_certs: false
|
||||
block:
|
||||
- name: keycloak_authz_custom_policy — remove custom policy if created
|
||||
middleware_automation.keycloak.keycloak_authz_custom_policy:
|
||||
@@ -517,19 +787,19 @@
|
||||
name: "{{ authz_scope }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — remove realm role from clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — remove realm role from client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
state: absent
|
||||
|
||||
- name: keycloak_clientscope_rolemappings — remove client role from clientscope
|
||||
middleware_automation.keycloak.keycloak_clientscope_rolemappings:
|
||||
- name: keycloak_client_scope_rolemappings — remove client role from client scope
|
||||
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
clientscope_id: "{{ scope }}"
|
||||
client_scope_id: "{{ scope }}"
|
||||
role_names:
|
||||
- "{{ client_role }}"
|
||||
state: absent
|
||||
@@ -537,7 +807,7 @@
|
||||
- name: keycloak_client_rolescope — remove role scope mapping
|
||||
middleware_automation.keycloak.keycloak_client_rolescope:
|
||||
realm: "{{ target_realm }}"
|
||||
client_id: "{{ client }}"
|
||||
target_client_id: "{{ client }}"
|
||||
role_names:
|
||||
- "{{ role }}"
|
||||
state: absent
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
vars_files:
|
||||
- ../group_vars/all/vars.yml
|
||||
vars:
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_hostname: "http://instance:8080"
|
||||
keycloak_config_override_template: custom.xml.j2
|
||||
keycloak_http_port: 8081
|
||||
keycloak_management_http_port: 19990
|
||||
|
||||
@@ -7,7 +7,7 @@ platforms:
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
keycloak_quarkus_show_deprecation_warnings: false
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_quarkus_hostname: https://instance:8443
|
||||
keycloak_quarkus_log: file
|
||||
keycloak_quarkus_log_level: debug # needed for the verify step
|
||||
@@ -25,7 +25,7 @@
|
||||
keycloak_quarkus_systemd_wait_for_delay: 2
|
||||
keycloak_quarkus_systemd_wait_for_log: true
|
||||
keycloak_quarkus_restart_health_check: false # would fail because of self-signed cert
|
||||
keycloak_quarkus_version: 26.4.7
|
||||
keycloak_quarkus_version: 26.6.2
|
||||
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx1024m"
|
||||
keycloak_quarkus_additional_env_vars:
|
||||
- key: KC_FEATURES_DISABLED
|
||||
@@ -39,16 +39,16 @@
|
||||
- key: default-connection-pool-size
|
||||
value: 10
|
||||
- id: spid-saml
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/24.0.2/spid-provider.jar
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.5.6/spid-provider.jar
|
||||
- id: spid-saml-w-checksum
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/24.0.2/spid-provider.jar
|
||||
checksum: sha256:fbb50e73739d7a6d35b5bff611b1c01668b29adf6f6259624b95e466a305f377
|
||||
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.5.6/spid-provider.jar
|
||||
checksum: sha256:2ddafc389a5f017d8665bfdfa2f72b3784fc74b9f3a482e796fa89a5ba5cc95b
|
||||
- id: keycloak-kerberos-federation
|
||||
maven:
|
||||
repository_url: https://repo1.maven.org/maven2/ # https://mvnrepository.com/artifact/org.keycloak/keycloak-kerberos-federation/24.0.4
|
||||
group_id: org.keycloak
|
||||
artifact_id: keycloak-kerberos-federation
|
||||
version: 26.4.7 # optional
|
||||
version: 26.6.3 # optional
|
||||
# username: myUser # optional
|
||||
# password: myPAT # optional
|
||||
# - id: my-static-theme
|
||||
@@ -62,34 +62,34 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: http://instance:8080
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_default_roles:
|
||||
keycloak_realm_url: http://instance:8080
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_default_roles:
|
||||
- TestRoleAdmin
|
||||
- TestRoleUser
|
||||
keycloak_client_users:
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
roles: "{{ keycloak_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
roles: "{{ keycloak_realm_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
|
||||
@@ -7,7 +7,7 @@ platforms:
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "8009/tcp"
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
keycloak_quarkus_show_deprecation_warnings: false
|
||||
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
|
||||
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_quarkus_log: file
|
||||
keycloak_quarkus_hostname: 'http://localhost:8080'
|
||||
keycloak_quarkus_start_dev: True
|
||||
@@ -18,34 +18,34 @@
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
- role: keycloak_realm
|
||||
keycloak_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_client_default_roles:
|
||||
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
|
||||
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
|
||||
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
|
||||
keycloak_realm_client_default_roles:
|
||||
- TestRoleAdmin
|
||||
- TestRoleUser
|
||||
keycloak_client_users:
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- username: TestAdmin
|
||||
password: password
|
||||
client_roles:
|
||||
- client: TestClient
|
||||
role: TestRoleUser
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
- client: TestClient
|
||||
role: TestRoleAdmin
|
||||
realm: "{{ keycloak_realm }}"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_clients:
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
roles: "{{ keycloak_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm }}"
|
||||
public_client: "{{ keycloak_client_public }}"
|
||||
web_origins: "{{ keycloak_client_web_origins }}"
|
||||
users: "{{ keycloak_client_users }}"
|
||||
roles: "{{ keycloak_realm_client_default_roles }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: "{{ keycloak_realm_client_public }}"
|
||||
web_origins: "{{ keycloak_realm_client_web_origins }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
client_id: TestClient
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
command: "/usr/sbin/init"
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8009/tcp"
|
||||
- "9000/tcp"
|
||||
|
||||
@@ -11,7 +11,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -24,7 +24,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -37,7 +37,7 @@ platforms:
|
||||
- database
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "5432/tcp"
|
||||
mounts:
|
||||
- type: bind
|
||||
|
||||
@@ -11,7 +11,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -24,7 +24,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -37,7 +37,7 @@ platforms:
|
||||
- database
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "5432/tcp"
|
||||
mounts:
|
||||
- type: bind
|
||||
|
||||
@@ -11,7 +11,7 @@ platforms:
|
||||
- keycloak
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "8443/tcp"
|
||||
- "9000/tcp"
|
||||
@@ -24,7 +24,7 @@ platforms:
|
||||
- infinispan
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "11222/tcp"
|
||||
- name: postgres
|
||||
image: ubuntu/postgres:14-22.04_beta
|
||||
@@ -35,7 +35,7 @@ platforms:
|
||||
- database
|
||||
networks:
|
||||
- name: rhbk
|
||||
port_bindings:
|
||||
exposed_ports:
|
||||
- "5432/tcp"
|
||||
mounts:
|
||||
- type: bind
|
||||
|
||||
@@ -9,6 +9,6 @@
|
||||
keycloak_quarkus_additional_env_vars:
|
||||
- key: KC_FEATURES_DISABLED
|
||||
value: ciba,device-flow,impersonation,kerberos,docker
|
||||
keycloak_quarkus_version: 26.0.7
|
||||
keycloak_quarkus_version: 26.6.2
|
||||
roles:
|
||||
- role: keycloak_quarkus
|
||||
|
||||
@@ -4,15 +4,15 @@ dependency:
|
||||
options:
|
||||
requirements-file: molecule/requirements.yml
|
||||
driver:
|
||||
name: podman
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
command: "/usr/sbin/init"
|
||||
pre_build_image: true
|
||||
privileged: true
|
||||
port_bindings:
|
||||
- 8080:8080
|
||||
exposed_ports:
|
||||
- "8080/tcp"
|
||||
- "9000/tcp"
|
||||
published_ports:
|
||||
- 0.0.0.0:8080:8080/TCP
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
- vars.yml
|
||||
vars:
|
||||
sudo_pkg_name: sudo
|
||||
keycloak_quarkus_version: 26.0.4
|
||||
keycloak_quarkus_version: 26.6.1
|
||||
keycloak_quarkus_additional_env_vars:
|
||||
- key: KC_FEATURES_DISABLED
|
||||
value: impersonation,kerberos
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
- name: Converge
|
||||
hosts: all
|
||||
vars_files:
|
||||
- ../group_vars/all/vars.yml
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_enable: true
|
||||
keycloak_offline_install: false
|
||||
roles:
|
||||
- role: keycloak
|
||||
- role: keycloak_realm
|
||||
keycloak_realm_url: "http://instance:8080"
|
||||
keycloak_realm_context: "/auth"
|
||||
keycloak_realm_admin_user: "admin"
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: true
|
||||
client_id: TestClient
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
dependency:
|
||||
name: galaxy
|
||||
driver:
|
||||
name: docker
|
||||
platforms:
|
||||
- name: instance
|
||||
image: registry.access.redhat.com/ubi9/ubi-init:latest
|
||||
command: /usr/sbin/init
|
||||
privileged: true
|
||||
pre_build_image: true
|
||||
provisioner:
|
||||
name: ansible
|
||||
config_options:
|
||||
defaults:
|
||||
interpreter_python: auto_silent
|
||||
callbacks_enabled: profile_tasks, timer, yaml
|
||||
ssh_connection:
|
||||
pipelining: false
|
||||
playbooks:
|
||||
prepare: prepare.yml
|
||||
converge: converge.yml
|
||||
verify: verify.yml
|
||||
env:
|
||||
ANSIBLE_ROLES_PATH: "../../roles"
|
||||
inventory:
|
||||
host_vars:
|
||||
instance:
|
||||
ansible_user: root
|
||||
verifier:
|
||||
name: ansible
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
- name: Prepare
|
||||
hosts: all
|
||||
vars_files:
|
||||
- ../group_vars/all/vars.yml
|
||||
gather_facts: yes
|
||||
vars:
|
||||
sudo_pkg_name: sudo
|
||||
tasks:
|
||||
- name: "Run preparation common to all scenario"
|
||||
ansible.builtin.include_tasks: ../prepare.yml
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
- name: Verify
|
||||
hosts: all
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_admin_user: "admin"
|
||||
keycloak_uri: "http://localhost:8080"
|
||||
keycloak_context: "/auth"
|
||||
tasks:
|
||||
- name: Populate service facts
|
||||
ansible.builtin.service_facts:
|
||||
- name: Check if keycloak service started
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- ansible_facts.services["keycloak.service"]["state"] == "running"
|
||||
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
|
||||
- name: Verify token api call
|
||||
ansible.builtin.uri:
|
||||
url: "{{ keycloak_uri }}{{ keycloak_context }}/realms/master/protocol/openid-connect/token"
|
||||
method: POST
|
||||
body: "client_id=admin-cli&username={{ keycloak_admin_user }}&password={{ keycloak_admin_password }}&grant_type=password"
|
||||
validate_certs: no
|
||||
register: keycloak_auth_response
|
||||
until: keycloak_auth_response.status == 200
|
||||
retries: 2
|
||||
delay: 2
|
||||
@@ -6,9 +6,9 @@
|
||||
ansible.builtin.include_role:
|
||||
name: keycloak_realm
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_user_federation:
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_user_federation:
|
||||
- realm: TestRealm
|
||||
name: my-ldap
|
||||
provider_id: ldap
|
||||
@@ -48,13 +48,13 @@
|
||||
ldap.full.name.attribute: cn
|
||||
read.only: true
|
||||
write.only: false
|
||||
keycloak_clients:
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient1
|
||||
client_id: TestClient1
|
||||
roles:
|
||||
- TestClient1Admin
|
||||
- TestClient1User
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
public_client: true
|
||||
web_origins:
|
||||
- http://testclient1origin/application
|
||||
@@ -65,4 +65,4 @@
|
||||
client_roles:
|
||||
- client: TestClient1
|
||||
role: TestClient1User
|
||||
realm: "{{ keycloak_realm }}"
|
||||
realm: "{{ keycloak_realm_realm }}"
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
- name: Playbook for Keycloak Hosts
|
||||
hosts: all
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_clients:
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient1
|
||||
client_id: TestClient1
|
||||
roles:
|
||||
@@ -23,4 +23,4 @@
|
||||
realm: TestRealm
|
||||
roles:
|
||||
- role: middleware_automation.keycloak.keycloak_realm
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_realm_realm: TestRealm
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
ansible.builtin.include_role:
|
||||
name: middleware_automation.keycloak.keycloak_realm
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_realm: TestRealm
|
||||
keycloak_client_default_roles:
|
||||
keycloak_realm_admin_password: "remembertochangeme"
|
||||
keycloak_realm_realm: TestRealm
|
||||
keycloak_realm_client_default_roles:
|
||||
- TestRoleAdmin
|
||||
- TestRoleUser
|
||||
keycloak_client_users:
|
||||
keycloak_realm_client_users:
|
||||
- username: TestUser
|
||||
password: password
|
||||
client_roles:
|
||||
@@ -27,13 +27,13 @@
|
||||
- client: TestClient1
|
||||
role: TestRoleAdmin
|
||||
realm: TestRealm
|
||||
keycloak_clients:
|
||||
keycloak_realm_clients:
|
||||
- name: TestClient1
|
||||
client_id: TestClient1
|
||||
roles: "{{ keycloak_client_default_roles }}"
|
||||
roles: "{{ keycloak_realm_client_default_roles }}"
|
||||
realm: TestRealm
|
||||
public_client: true
|
||||
web_origins:
|
||||
- http://testclient1origin/application
|
||||
- http://testclient1origin/other
|
||||
users: "{{ keycloak_client_users }}"
|
||||
users: "{{ keycloak_realm_client_users }}"
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,9 @@
|
||||
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
|
||||
# Do not use this from other collections or standalone plugins/modules!
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
import typing as t
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -2,7 +2,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
import typing as t
|
||||
|
||||
@@ -66,7 +68,7 @@ def keycloak_clientsecret_module_resolve_params(module: AnsibleModule, kc: Keycl
|
||||
# less lookup.
|
||||
if id is None:
|
||||
# Due to the required_one_of spec, client_id is guaranteed to not be None
|
||||
client = kc.get_client_by_clientid(client_id, realm=realm)
|
||||
client = kc.get_client_by_client_id(client_id, realm=realm)
|
||||
|
||||
if client is None:
|
||||
module.fail_json(msg=f"Client does not exist {client_id}")
|
||||
|
||||
@@ -2,7 +2,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_authentication
|
||||
|
||||
@@ -5,7 +5,8 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_authentication_required_actions
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_authentication_v2
|
||||
@@ -28,7 +30,7 @@ description:
|
||||
If the option is V(false) and a temporary flow already exists, the module will fail to prevent accidental data loss.
|
||||
- B(Idempotency) - If the existing flow already matches the desired configuration, no changes are made.
|
||||
The module compares a normalised representation of the existing flow against the desired state before deciding whether to trigger the Safe Swap procedure.
|
||||
- A depth of 4 sub-flows is supported.
|
||||
- A depth of 10 sub-flows is supported.
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
@@ -220,7 +222,7 @@ options:
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 4 (last sub level).
|
||||
- Executions at sub level 4.
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
@@ -234,7 +236,6 @@ options:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
required: true
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
@@ -248,6 +249,247 @@ options:
|
||||
description: Options for the execution config.
|
||||
required: true
|
||||
type: dict
|
||||
subFlow:
|
||||
description:
|
||||
- The name of the sub-flow.
|
||||
type: str
|
||||
subFlowType:
|
||||
description:
|
||||
- The type of the sub-flow.
|
||||
choices: [basic-flow, form-flow]
|
||||
default: basic-flow
|
||||
type: str
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 5.
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
requirement:
|
||||
description:
|
||||
- The requirement status of the execution or sub-flow.
|
||||
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||
type: str
|
||||
required: true
|
||||
providerId:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
type: dict
|
||||
suboptions:
|
||||
alias:
|
||||
description: Name of the execution config.
|
||||
type: str
|
||||
required: true
|
||||
config:
|
||||
description: Options for the execution config.
|
||||
required: true
|
||||
type: dict
|
||||
subFlow:
|
||||
description:
|
||||
- The name of the sub-flow.
|
||||
type: str
|
||||
subFlowType:
|
||||
description:
|
||||
- The type of the sub-flow.
|
||||
choices: [basic-flow, form-flow]
|
||||
default: basic-flow
|
||||
type: str
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 6.
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
requirement:
|
||||
description:
|
||||
- The requirement status of the execution or sub-flow.
|
||||
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||
type: str
|
||||
required: true
|
||||
providerId:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
type: dict
|
||||
suboptions:
|
||||
alias:
|
||||
description: Name of the execution config.
|
||||
type: str
|
||||
required: true
|
||||
config:
|
||||
description: Options for the execution config.
|
||||
required: true
|
||||
type: dict
|
||||
subFlow:
|
||||
description:
|
||||
- The name of the sub-flow.
|
||||
type: str
|
||||
subFlowType:
|
||||
description:
|
||||
- The type of the sub-flow.
|
||||
choices: [basic-flow, form-flow]
|
||||
default: basic-flow
|
||||
type: str
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 7.
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
requirement:
|
||||
description:
|
||||
- The requirement status of the execution or sub-flow.
|
||||
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||
type: str
|
||||
required: true
|
||||
providerId:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
type: dict
|
||||
suboptions:
|
||||
alias:
|
||||
description: Name of the execution config.
|
||||
type: str
|
||||
required: true
|
||||
config:
|
||||
description: Options for the execution config.
|
||||
required: true
|
||||
type: dict
|
||||
subFlow:
|
||||
description:
|
||||
- The name of the sub-flow.
|
||||
type: str
|
||||
subFlowType:
|
||||
description:
|
||||
- The type of the sub-flow.
|
||||
choices: [basic-flow, form-flow]
|
||||
default: basic-flow
|
||||
type: str
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 8.
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
requirement:
|
||||
description:
|
||||
- The requirement status of the execution or sub-flow.
|
||||
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||
type: str
|
||||
required: true
|
||||
providerId:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
type: dict
|
||||
suboptions:
|
||||
alias:
|
||||
description: Name of the execution config.
|
||||
type: str
|
||||
required: true
|
||||
config:
|
||||
description: Options for the execution config.
|
||||
required: true
|
||||
type: dict
|
||||
subFlow:
|
||||
description:
|
||||
- The name of the sub-flow.
|
||||
type: str
|
||||
subFlowType:
|
||||
description:
|
||||
- The type of the sub-flow.
|
||||
choices: [basic-flow, form-flow]
|
||||
default: basic-flow
|
||||
type: str
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 9.
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
requirement:
|
||||
description:
|
||||
- The requirement status of the execution or sub-flow.
|
||||
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||
type: str
|
||||
required: true
|
||||
providerId:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
type: dict
|
||||
suboptions:
|
||||
alias:
|
||||
description: Name of the execution config.
|
||||
type: str
|
||||
required: true
|
||||
config:
|
||||
description: Options for the execution config.
|
||||
required: true
|
||||
type: dict
|
||||
subFlow:
|
||||
description:
|
||||
- The name of the sub-flow.
|
||||
type: str
|
||||
subFlowType:
|
||||
description:
|
||||
- The type of the sub-flow.
|
||||
choices: [basic-flow, form-flow]
|
||||
default: basic-flow
|
||||
type: str
|
||||
authenticationExecutions:
|
||||
description:
|
||||
- The execution configuration for executions within the sub-flow.
|
||||
- Executions at sub level 10 (last sub level).
|
||||
type: list
|
||||
elements: dict
|
||||
suboptions:
|
||||
requirement:
|
||||
description:
|
||||
- The requirement status of the execution or sub-flow.
|
||||
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
|
||||
type: str
|
||||
required: true
|
||||
providerId:
|
||||
description:
|
||||
- The C(providerId) of the execution.
|
||||
type: str
|
||||
required: true
|
||||
authenticationConfig:
|
||||
description:
|
||||
- The configuration for the execution.
|
||||
type: dict
|
||||
suboptions:
|
||||
alias:
|
||||
description: Name of the execution config.
|
||||
type: str
|
||||
required: true
|
||||
config:
|
||||
description: Options for the execution config.
|
||||
required: true
|
||||
type: dict
|
||||
state:
|
||||
description:
|
||||
- Whether the authentication flow should exist or not.
|
||||
@@ -851,7 +1093,7 @@ def main() -> None:
|
||||
authenticationExecutions=dict(
|
||||
type="list",
|
||||
elements="dict",
|
||||
options=create_authentication_execution_spec_options(4),
|
||||
options=create_authentication_execution_spec_options(10),
|
||||
),
|
||||
state=dict(choices=["absent", "present"], default="present"),
|
||||
force_temporary_swap_flow_deletion=dict(type="bool", default=True),
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_authz_authorization_scope
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_authz_custom_policy
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_authz_permission
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_authz_permission_info
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_client
|
||||
@@ -1100,11 +1102,11 @@ def add_default_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in desired_default_scope if item not in before_client["defaultClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_clientscopes(realm)
|
||||
client_scopes = kc.get_client_scopes(realm)
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.add_default_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.add_default_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def add_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
@@ -1139,11 +1141,11 @@ def add_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in desired_optional_scope if item not in before_client["optionalClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_clientscopes(realm)
|
||||
client_scopes = kc.get_client_scopes(realm)
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.add_optional_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.add_optional_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def remove_default_client_scopes(desired_client, before_client, realm, kc):
|
||||
@@ -1178,11 +1180,11 @@ def remove_default_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in before_default_scope if item not in desired_client["defaultClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_default_clientscopes(realm, desired_client["clientId"])
|
||||
client_scopes = kc.get_default_client_scopes(realm, desired_client["clientId"])
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.delete_default_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.delete_default_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def remove_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
@@ -1217,11 +1219,11 @@ def remove_optional_client_scopes(desired_client, before_client, realm, kc):
|
||||
missing_scopes = [item for item in before_optional_scope if item not in desired_client["optionalClientScopes"]]
|
||||
if not missing_scopes:
|
||||
return
|
||||
client_scopes = kc.get_optional_clientscopes(realm, desired_client["clientId"])
|
||||
client_scopes = kc.get_optional_client_scopes(realm, desired_client["clientId"])
|
||||
for name in missing_scopes:
|
||||
scope = find_match(client_scopes, "name", name)
|
||||
if scope:
|
||||
kc.delete_optional_clientscope(scope["id"], realm, desired_client["clientId"])
|
||||
kc.delete_optional_client_scope(scope["id"], realm, desired_client["clientId"])
|
||||
|
||||
|
||||
def main():
|
||||
@@ -1346,7 +1348,7 @@ def main():
|
||||
|
||||
# See if it already exists in Keycloak
|
||||
if cid is None:
|
||||
before_client = kc.get_client_by_clientid(module.params.get("client_id"), realm=realm)
|
||||
before_client = kc.get_client_by_client_id(module.params.get("client_id"), realm=realm)
|
||||
if before_client is not None:
|
||||
cid = before_client["id"]
|
||||
else:
|
||||
@@ -1440,7 +1442,7 @@ def main():
|
||||
|
||||
# create it
|
||||
kc.create_client(desired_client, realm=realm)
|
||||
after_client = kc.get_client_by_clientid(desired_client["clientId"], realm=realm)
|
||||
after_client = kc.get_client_by_client_id(desired_client["clientId"], realm=realm)
|
||||
|
||||
result["end_state"] = sanitize_cr(after_client)
|
||||
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_client_rolemapping
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_client_rolescope
|
||||
@@ -19,7 +21,7 @@ description:
|
||||
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 O(client_id) must have O(middleware_automation.keycloak.keycloak_client#module:full_scope_allowed) set to V(false).
|
||||
- Client O(target_client_id) must have O(middleware_automation.keycloak.keycloak_client#module:full_scope_allowed) set to V(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.
|
||||
@@ -50,12 +52,12 @@ options:
|
||||
- The Keycloak realm under which clients resides.
|
||||
default: 'master'
|
||||
|
||||
client_id:
|
||||
target_client_id:
|
||||
type: str
|
||||
required: true
|
||||
description:
|
||||
- Roles provided in O(role_names) while be added to this client scope.
|
||||
client_scope_id:
|
||||
role_owner_client_id:
|
||||
type: str
|
||||
description:
|
||||
- If the O(role_names) are client role, the client ID under which it resides.
|
||||
@@ -66,8 +68,8 @@ options:
|
||||
elements: str
|
||||
description:
|
||||
- Names of roles to manipulate.
|
||||
- If O(client_scope_id) is present, all roles must be under this client.
|
||||
- If O(client_scope_id) is absent, all roles must be under the realm.
|
||||
- If O(role_owner_client_id) is present, all roles must be under this client.
|
||||
- If O(role_owner_client_id) is absent, all roles must be under the realm.
|
||||
extends_documentation_fragment:
|
||||
- middleware_automation.keycloak.keycloak
|
||||
- middleware_automation.keycloak.actiongroup_keycloak
|
||||
@@ -85,8 +87,8 @@ EXAMPLES = r"""
|
||||
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
|
||||
@@ -98,8 +100,8 @@ EXAMPLES = r"""
|
||||
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
|
||||
@@ -111,7 +113,7 @@ EXAMPLES = r"""
|
||||
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
|
||||
@@ -167,8 +169,8 @@ def main():
|
||||
argument_spec = keycloak_argument_spec()
|
||||
|
||||
meta_args = dict(
|
||||
client_id=dict(type="str", required=True),
|
||||
client_scope_id=dict(type="str"),
|
||||
target_client_id=dict(type="str", required=True),
|
||||
role_owner_client_id=dict(type="str"),
|
||||
realm=dict(type="str", default="master"),
|
||||
role_names=dict(type="list", elements="str", required=True),
|
||||
state=dict(type="str", default="present", choices=["present", "absent"]),
|
||||
@@ -189,8 +191,8 @@ def main():
|
||||
kc = KeycloakAPI(module, connection_header)
|
||||
|
||||
realm = module.params.get("realm")
|
||||
clientid = module.params.get("client_id")
|
||||
client_scope_id = module.params.get("client_scope_id")
|
||||
target_client_id = module.params.get("target_client_id")
|
||||
role_owner_client_id = module.params.get("role_owner_client_id")
|
||||
role_names = module.params.get("role_names")
|
||||
state = module.params.get("state")
|
||||
|
||||
@@ -198,23 +200,23 @@ def main():
|
||||
if not objRealm:
|
||||
module.fail_json(msg=f"Failed to retrive realm '{realm}'")
|
||||
|
||||
objClient = kc.get_client_by_clientid(clientid, realm)
|
||||
objClient = kc.get_client_by_client_id(target_client_id, realm)
|
||||
if not objClient:
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{clientid}'")
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{target_client_id}'")
|
||||
if objClient["fullScopeAllowed"] and state == "present":
|
||||
module.fail_json(msg=f"FullScopeAllowed is active for Client '{realm}.{clientid}'")
|
||||
module.fail_json(msg=f"FullScopeAllowed is active for Client '{realm}.{target_client_id}'")
|
||||
|
||||
if client_scope_id:
|
||||
objClientScope = kc.get_client_by_clientid(client_scope_id, realm)
|
||||
if not objClientScope:
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{client_scope_id}'")
|
||||
before_role_mapping = kc.get_client_role_scope_from_client(objClient["id"], objClientScope["id"], realm)
|
||||
if role_owner_client_id:
|
||||
role_owner_client = kc.get_client_by_client_id(role_owner_client_id, realm)
|
||||
if not role_owner_client:
|
||||
module.fail_json(msg=f"Failed to retrive client '{realm}.{role_owner_client_id}'")
|
||||
before_role_mapping = kc.get_client_role_scope_from_client(objClient["id"], role_owner_client["id"], realm)
|
||||
else:
|
||||
before_role_mapping = kc.get_client_role_scope_from_realm(objClient["id"], realm)
|
||||
|
||||
if client_scope_id:
|
||||
if role_owner_client_id:
|
||||
# retrive all role from client_scope
|
||||
client_scope_roles_by_name = kc.get_client_roles_by_id(objClientScope["id"], realm)
|
||||
client_scope_roles_by_name = kc.get_client_roles_by_id(role_owner_client["id"], realm)
|
||||
else:
|
||||
# retrive all role from realm
|
||||
client_scope_roles_by_name = kc.get_realm_roles(realm)
|
||||
@@ -228,8 +230,8 @@ def main():
|
||||
# update desired
|
||||
for role_name in role_names:
|
||||
if role_name not in client_scope_roles_by_name:
|
||||
if client_scope_id:
|
||||
module.fail_json(msg=f"Failed to retrive role '{realm}.{client_scope_id}.{role_name}'")
|
||||
if role_owner_client_id:
|
||||
module.fail_json(msg=f"Failed to retrive role '{realm}.{role_owner_client_id}.{role_name}'")
|
||||
else:
|
||||
module.fail_json(msg=f"Failed to retrive role '{realm}.{role_name}'")
|
||||
if role_name not in role_mapping_by_name:
|
||||
@@ -253,33 +255,33 @@ def main():
|
||||
if not result["changed"]:
|
||||
# no changes
|
||||
result["end_state"] = before_role_mapping
|
||||
result["msg"] = f"No changes required for client role scope {clientid}."
|
||||
result["msg"] = f"No changes required for client role scope {target_client_id}."
|
||||
elif state == "present":
|
||||
# doing update
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_scope_id:
|
||||
elif role_owner_client_id:
|
||||
result["end_state"] = kc.update_client_role_scope_from_client(
|
||||
role_mapping_to_manipulate, objClient["id"], objClientScope["id"], realm
|
||||
role_mapping_to_manipulate, objClient["id"], role_owner_client["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.update_client_role_scope_from_realm(
|
||||
role_mapping_to_manipulate, objClient["id"], realm
|
||||
)
|
||||
result["msg"] = f"Client role scope for {clientid} has been updated"
|
||||
result["msg"] = f"Client role scope for {target_client_id} has been updated"
|
||||
else:
|
||||
# doing delete
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_scope_id:
|
||||
elif role_owner_client_id:
|
||||
result["end_state"] = kc.delete_client_role_scope_from_client(
|
||||
role_mapping_to_manipulate, objClient["id"], objClientScope["id"], realm
|
||||
role_mapping_to_manipulate, objClient["id"], role_owner_client["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.delete_client_role_scope_from_realm(
|
||||
role_mapping_to_manipulate, objClient["id"], realm
|
||||
)
|
||||
result["msg"] = f"Client role scope for {clientid} has been deleted"
|
||||
result["msg"] = f"Client role scope for {target_client_id} has been deleted"
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,8 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
@@ -230,7 +231,7 @@ def main():
|
||||
attributes = module.params.get('attributes')
|
||||
protocol_mappers = module.params.get('protocol_mappers')
|
||||
|
||||
before_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
before_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
|
||||
if state == 'absent':
|
||||
if before_scope:
|
||||
@@ -239,7 +240,7 @@ def main():
|
||||
result['diff'] = dict(before=before_scope, after='')
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.delete_clientscope(cid=before_scope['id'], realm=realm)
|
||||
kc.delete_client_scope(cid=before_scope['id'], realm=realm)
|
||||
result['msg'] = "Client scope {name} has been deleted".format(name=name)
|
||||
else:
|
||||
result['msg'] = "Client scope {name} does not exist, doing nothing".format(name=name)
|
||||
@@ -261,8 +262,8 @@ def main():
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
|
||||
kc.create_clientscope(scope_rep, realm=realm)
|
||||
after_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
kc.create_client_scope(scope_rep, realm=realm)
|
||||
after_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
|
||||
if protocol_mappers:
|
||||
for mapper in protocol_mappers:
|
||||
@@ -272,8 +273,8 @@ def main():
|
||||
'protocolMapper': mapper['protocolMapper'],
|
||||
'config': mapper['config'],
|
||||
}
|
||||
kc.create_clientscope_protocolmapper(after_scope['id'], mapper_rep, realm=realm)
|
||||
after_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
kc.create_client_scope_protocolmapper(after_scope['id'], mapper_rep, realm=realm)
|
||||
after_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
|
||||
result['end_state'] = after_scope
|
||||
result['msg'] = "Client scope {name} has been created".format(name=name)
|
||||
@@ -296,10 +297,10 @@ def main():
|
||||
result['diff'] = dict(before=before_scope, after=scope_rep)
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
kc.update_clientscope(scope_rep, realm=realm)
|
||||
kc.update_client_scope(scope_rep, realm=realm)
|
||||
|
||||
if protocol_mappers:
|
||||
existing_mappers = kc.get_clientscope_protocolmappers(before_scope['id'], realm=realm)
|
||||
existing_mappers = kc.get_client_scope_protocolmappers(before_scope['id'], realm=realm)
|
||||
existing_mapper_names = {m['name'] for m in existing_mappers}
|
||||
|
||||
for mapper in protocol_mappers:
|
||||
@@ -312,9 +313,9 @@ def main():
|
||||
'protocolMapper': mapper['protocolMapper'],
|
||||
'config': mapper['config'],
|
||||
}
|
||||
kc.create_clientscope_protocolmapper(before_scope['id'], mapper_rep, realm=realm)
|
||||
kc.create_client_scope_protocolmapper(before_scope['id'], mapper_rep, realm=realm)
|
||||
|
||||
after_scope = kc.get_clientscope_by_name(name, realm=realm)
|
||||
after_scope = kc.get_client_scope_by_name(name, realm=realm)
|
||||
result['end_state'] = after_scope
|
||||
|
||||
if result['changed']:
|
||||
|
||||
+37
-35
@@ -3,19 +3,21 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_clientscope_rolemappings
|
||||
module: keycloak_client_scope_rolemappings
|
||||
|
||||
short_description: Allows administration of Keycloak clientscope scope mappings to restrict the usage of certain roles to
|
||||
specific clientscopes
|
||||
short_description: Allows administration of Keycloak client scope scope mappings to restrict the usage of certain roles to
|
||||
specific client scopes
|
||||
|
||||
# Originally added in community.general 13.1.0
|
||||
version_added: "3.0.0"
|
||||
|
||||
description:
|
||||
- This module allows you to add or remove Keycloak roles from clientscopes using the Keycloak REST API. It requires access
|
||||
- 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, C(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.
|
||||
@@ -49,11 +51,11 @@ options:
|
||||
- The Keycloak realm under which clients resides.
|
||||
default: 'master'
|
||||
|
||||
clientscope_id:
|
||||
client_scope_id:
|
||||
required: true
|
||||
type: str
|
||||
description:
|
||||
- Roles provided in O(role_names) will be added to this clientscope.
|
||||
- Roles provided in O(role_names) will be added to this client scope.
|
||||
|
||||
client_id:
|
||||
type: str
|
||||
@@ -81,40 +83,40 @@ author:
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
- 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
|
||||
@@ -122,7 +124,7 @@ EXAMPLES = r"""
|
||||
|
||||
RETURN = r"""
|
||||
end_state:
|
||||
description: Representation of clientscope scope mappings after module execution.
|
||||
description: Representation of client scope scope mappings after module execution.
|
||||
returned: on success
|
||||
type: list
|
||||
elements: dict
|
||||
@@ -164,7 +166,7 @@ def main():
|
||||
|
||||
meta_args = dict(
|
||||
client_id=dict(type="str"),
|
||||
clientscope_id=dict(type="str", required=True),
|
||||
client_scope_id=dict(type="str", required=True),
|
||||
realm=dict(type="str", default="master"),
|
||||
role_names=dict(type="list", elements="str", required=True),
|
||||
state=dict(type="str", default="present", choices=["present", "absent"]),
|
||||
@@ -186,7 +188,7 @@ def main():
|
||||
|
||||
realm = module.params["realm"]
|
||||
client_id = module.params["client_id"]
|
||||
clientscope_id = module.params["clientscope_id"]
|
||||
client_scope_id = module.params["client_scope_id"]
|
||||
role_names = module.params["role_names"]
|
||||
state = module.params["state"]
|
||||
|
||||
@@ -194,23 +196,23 @@ def main():
|
||||
if not realm_object:
|
||||
module.fail_json(msg=f"Failed to retrieve realm '{realm}'")
|
||||
|
||||
clientscope_object = kc.get_clientscope_by_name(clientscope_id, realm)
|
||||
if not clientscope_object:
|
||||
module.fail_json(msg=f"Failed to retrieve client-scope '{clientscope_id}'")
|
||||
client_scope_object = kc.get_client_scope_by_name(client_scope_id, realm)
|
||||
if not client_scope_object:
|
||||
module.fail_json(msg=f"Failed to retrieve client scope '{client_scope_id}'")
|
||||
|
||||
if client_id:
|
||||
# add client role
|
||||
client_object = kc.get_client_by_clientid(client_id, realm)
|
||||
client_object = kc.get_client_by_client_id(client_id, realm)
|
||||
if not client_object:
|
||||
module.fail_json(msg=f"Failed to retrieve client '{realm}.{client_id}'")
|
||||
if client_object["fullScopeAllowed"] and state == "present":
|
||||
module.fail_json(msg=f"FullScopeAllowed is active for Client '{realm}.{client_id}'")
|
||||
|
||||
before_roles = kc.get_clientscope_scope_mappings_client(clientscope_object["id"], client_object["id"], realm)
|
||||
before_roles = kc.get_client_scope_scope_mappings_client(client_scope_object["id"], client_object["id"], realm)
|
||||
available_roles_by_name = kc.get_client_roles_by_id(client_object["id"], realm)
|
||||
else:
|
||||
# add realm role
|
||||
before_roles = kc.get_clientscope_scope_mappings_realm(clientscope_object["id"], realm)
|
||||
before_roles = kc.get_client_scope_scope_mappings_realm(client_scope_object["id"], realm)
|
||||
available_roles_by_name = kc.get_realm_roles(realm)
|
||||
|
||||
# convert to indexed Dict by name
|
||||
@@ -248,33 +250,33 @@ def main():
|
||||
if not result["changed"]:
|
||||
# no changes
|
||||
result["end_state"] = before_roles
|
||||
result["msg"] = f"No changes required for clientscope {clientscope_id}."
|
||||
result["msg"] = f"No changes required for client scope {client_scope_id}."
|
||||
elif state == "present":
|
||||
# doing update
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_id:
|
||||
result["end_state"] = kc.update_clientscope_scope_mappings_client(
|
||||
changed_roles, clientscope_object["id"], client_object["id"], realm
|
||||
result["end_state"] = kc.update_client_scope_scope_mappings_client(
|
||||
changed_roles, client_scope_object["id"], client_object["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.update_clientscope_scope_mappings_realm(
|
||||
changed_roles, clientscope_object["id"], realm
|
||||
result["end_state"] = kc.update_client_scope_scope_mappings_realm(
|
||||
changed_roles, client_scope_object["id"], realm
|
||||
)
|
||||
result["msg"] = f"Clientscope scope mappings for {clientscope_id} have been updated"
|
||||
result["msg"] = f"Clientscope scope mappings for {client_scope_id} have been updated"
|
||||
else:
|
||||
# doing delete
|
||||
if module.check_mode:
|
||||
result["end_state"] = desired_role_mapping
|
||||
elif client_id:
|
||||
result["end_state"] = kc.delete_clientscope_scope_mappings_client(
|
||||
changed_roles, clientscope_object["id"], client_object["id"], realm
|
||||
result["end_state"] = kc.delete_client_scope_scope_mappings_client(
|
||||
changed_roles, client_scope_object["id"], client_object["id"], realm
|
||||
)
|
||||
else:
|
||||
result["end_state"] = kc.delete_clientscope_scope_mappings_realm(
|
||||
changed_roles, clientscope_object["id"], realm
|
||||
result["end_state"] = kc.delete_client_scope_scope_mappings_realm(
|
||||
changed_roles, client_scope_object["id"], realm
|
||||
)
|
||||
result["msg"] = f"Clientscope scope mappings for {clientscope_id} have been deleted"
|
||||
result["msg"] = f"Clientscope scope mappings for {client_scope_id} have been deleted"
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
+79
-77
@@ -3,18 +3,20 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_clientscope_type
|
||||
module: keycloak_client_scope_type
|
||||
|
||||
short_description: Set the type of aclientscope in realm or client using Keycloak API
|
||||
short_description: Set the type of a client scope in a realm or client using the Keycloak API
|
||||
|
||||
# Originally added in community.general 6.6.0
|
||||
version_added: "3.0.0"
|
||||
|
||||
description:
|
||||
- This module allows you to set the type (optional, default) of clientscopes using the Keycloak REST API. It requires access
|
||||
- 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.
|
||||
@@ -36,18 +38,18 @@ options:
|
||||
|
||||
client_id:
|
||||
description:
|
||||
- The O(client_id) of the client. If not set the clientscope types are set as a default for the realm.
|
||||
- The O(client_id) of the client. If not set the client scope types are set as a default for the realm.
|
||||
aliases:
|
||||
- clientId
|
||||
type: str
|
||||
|
||||
default_clientscopes:
|
||||
default_client_scopes:
|
||||
description:
|
||||
- Client scopes that should be of type default.
|
||||
type: list
|
||||
elements: str
|
||||
|
||||
optional_clientscopes:
|
||||
optional_client_scopes:
|
||||
description:
|
||||
- Client scopes that should be of type optional.
|
||||
type: list
|
||||
@@ -64,26 +66,26 @@ author:
|
||||
|
||||
EXAMPLES = r"""
|
||||
- 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
|
||||
"""
|
||||
|
||||
@@ -94,16 +96,16 @@ msg:
|
||||
type: str
|
||||
sample: ""
|
||||
proposed:
|
||||
description: Representation of proposed client-scope types mapping.
|
||||
description: Representation of proposed client scope types mapping.
|
||||
returned: always
|
||||
type: dict
|
||||
sample:
|
||||
{
|
||||
"default_clientscopes": [
|
||||
"default_client_scopes": [
|
||||
"profile",
|
||||
"role"
|
||||
],
|
||||
"optional_clientscopes": []
|
||||
"optional_client_scopes": []
|
||||
}
|
||||
existing:
|
||||
description:
|
||||
@@ -112,11 +114,11 @@ existing:
|
||||
type: dict
|
||||
sample:
|
||||
{
|
||||
"default_clientscopes": [
|
||||
"default_client_scopes": [
|
||||
"profile",
|
||||
"role"
|
||||
],
|
||||
"optional_clientscopes": [
|
||||
"optional_client_scopes": [
|
||||
"phone"
|
||||
]
|
||||
}
|
||||
@@ -128,11 +130,11 @@ end_state:
|
||||
type: dict
|
||||
sample:
|
||||
{
|
||||
"default_clientscopes": [
|
||||
"default_client_scopes": [
|
||||
"profile",
|
||||
"role"
|
||||
],
|
||||
"optional_clientscopes": []
|
||||
"optional_client_scopes": []
|
||||
}
|
||||
"""
|
||||
|
||||
@@ -146,7 +148,7 @@ from ansible_collections.middleware_automation.keycloak.plugins.module_utils.ide
|
||||
)
|
||||
|
||||
|
||||
def keycloak_clientscope_type_module():
|
||||
def keycloak_client_scope_type_module():
|
||||
"""
|
||||
Returns an AnsibleModule definition.
|
||||
|
||||
@@ -157,8 +159,8 @@ def keycloak_clientscope_type_module():
|
||||
meta_args = dict(
|
||||
realm=dict(default="master"),
|
||||
client_id=dict(type="str", aliases=["clientId"]),
|
||||
default_clientscopes=dict(type="list", elements="str"),
|
||||
optional_clientscopes=dict(type="list", elements="str"),
|
||||
default_client_scopes=dict(type="list", elements="str"),
|
||||
optional_client_scopes=dict(type="list", elements="str"),
|
||||
)
|
||||
|
||||
argument_spec.update(meta_args)
|
||||
@@ -169,7 +171,7 @@ def keycloak_clientscope_type_module():
|
||||
required_one_of=(
|
||||
[
|
||||
["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"],
|
||||
["default_clientscopes", "optional_clientscopes"],
|
||||
["default_client_scopes", "optional_client_scopes"],
|
||||
]
|
||||
),
|
||||
required_together=([["auth_username", "auth_password"]]),
|
||||
@@ -180,21 +182,21 @@ def keycloak_clientscope_type_module():
|
||||
return module
|
||||
|
||||
|
||||
def clientscopes_to_add(existing, proposed):
|
||||
def client_scopes_to_add(existing, proposed):
|
||||
to_add = []
|
||||
existing_clientscope_ids = extract_field(existing, "id")
|
||||
for clientscope in proposed:
|
||||
if clientscope["id"] not in existing_clientscope_ids:
|
||||
to_add.append(clientscope)
|
||||
existing_client_scope_ids = extract_field(existing, "id")
|
||||
for client_scope in proposed:
|
||||
if client_scope["id"] not in existing_client_scope_ids:
|
||||
to_add.append(client_scope)
|
||||
return to_add
|
||||
|
||||
|
||||
def clientscopes_to_delete(existing, proposed):
|
||||
def client_scopes_to_delete(existing, proposed):
|
||||
to_delete = []
|
||||
proposed_clientscope_ids = extract_field(proposed, "id")
|
||||
for clientscope in existing:
|
||||
if clientscope["id"] not in proposed_clientscope_ids:
|
||||
to_delete.append(clientscope)
|
||||
proposed_client_scope_ids = extract_field(proposed, "id")
|
||||
for client_scope in existing:
|
||||
if client_scope["id"] not in proposed_client_scope_ids:
|
||||
to_delete.append(client_scope)
|
||||
return to_delete
|
||||
|
||||
|
||||
@@ -204,21 +206,21 @@ def extract_field(dictionary, field="name"):
|
||||
|
||||
def normalize_scopes(scopes):
|
||||
scopes_copy = scopes.copy()
|
||||
if isinstance(scopes_copy.get("default_clientscopes"), list):
|
||||
scopes_copy["default_clientscopes"] = sorted(scopes_copy["default_clientscopes"])
|
||||
if isinstance(scopes_copy.get("optional_clientscopes"), list):
|
||||
scopes_copy["optional_clientscopes"] = sorted(scopes_copy["optional_clientscopes"])
|
||||
if isinstance(scopes_copy.get("default_client_scopes"), list):
|
||||
scopes_copy["default_client_scopes"] = sorted(scopes_copy["default_client_scopes"])
|
||||
if isinstance(scopes_copy.get("optional_client_scopes"), list):
|
||||
scopes_copy["optional_client_scopes"] = sorted(scopes_copy["optional_client_scopes"])
|
||||
return scopes_copy
|
||||
|
||||
|
||||
def main():
|
||||
"""
|
||||
Module keycloak_clientscope_type
|
||||
Module keycloak_client_scope_type
|
||||
|
||||
:return:
|
||||
"""
|
||||
|
||||
module = keycloak_clientscope_type_module()
|
||||
module = keycloak_client_scope_type_module()
|
||||
|
||||
# Obtain access token, initialize API
|
||||
try:
|
||||
@@ -230,81 +232,81 @@ def main():
|
||||
|
||||
realm = module.params.get("realm")
|
||||
client_id = module.params.get("client_id")
|
||||
default_clientscopes = module.params.get("default_clientscopes")
|
||||
optional_clientscopes = module.params.get("optional_clientscopes")
|
||||
default_client_scopes = module.params.get("default_client_scopes")
|
||||
optional_client_scopes = module.params.get("optional_client_scopes")
|
||||
|
||||
result = dict(changed=False, msg="", proposed={}, existing={}, end_state={})
|
||||
|
||||
all_clientscopes = kc.get_clientscopes(realm)
|
||||
default_clientscopes_real = []
|
||||
optional_clientscopes_real = []
|
||||
all_client_scopes = kc.get_client_scopes(realm)
|
||||
default_client_scopes_real = []
|
||||
optional_client_scopes_real = []
|
||||
|
||||
for client_scope in all_clientscopes:
|
||||
if default_clientscopes is not None and client_scope["name"] in default_clientscopes:
|
||||
default_clientscopes_real.append(client_scope)
|
||||
if optional_clientscopes is not None and client_scope["name"] in optional_clientscopes:
|
||||
optional_clientscopes_real.append(client_scope)
|
||||
for client_scope in all_client_scopes:
|
||||
if default_client_scopes is not None and client_scope["name"] in default_client_scopes:
|
||||
default_client_scopes_real.append(client_scope)
|
||||
if optional_client_scopes is not None and client_scope["name"] in optional_client_scopes:
|
||||
optional_client_scopes_real.append(client_scope)
|
||||
|
||||
if default_clientscopes is not None and len(default_clientscopes_real) != len(default_clientscopes):
|
||||
module.fail_json(msg="At least one of the default_clientscopes does not exist!")
|
||||
if default_client_scopes is not None and len(default_client_scopes_real) != len(default_client_scopes):
|
||||
module.fail_json(msg="At least one of the default_client_scopes does not exist!")
|
||||
|
||||
if optional_clientscopes is not None and len(optional_clientscopes_real) != len(optional_clientscopes):
|
||||
module.fail_json(msg="At least one of the optional_clientscopes does not exist!")
|
||||
if optional_client_scopes is not None and len(optional_client_scopes_real) != len(optional_client_scopes):
|
||||
module.fail_json(msg="At least one of the optional_client_scopes does not exist!")
|
||||
|
||||
result["proposed"].update(
|
||||
{
|
||||
"default_clientscopes": "no-change" if default_clientscopes is None else default_clientscopes,
|
||||
"optional_clientscopes": "no-change" if optional_clientscopes is None else optional_clientscopes,
|
||||
"default_client_scopes": "no-change" if default_client_scopes is None else default_client_scopes,
|
||||
"optional_client_scopes": "no-change" if optional_client_scopes is None else optional_client_scopes,
|
||||
}
|
||||
)
|
||||
|
||||
default_clientscopes_existing = kc.get_default_clientscopes(realm, client_id)
|
||||
optional_clientscopes_existing = kc.get_optional_clientscopes(realm, client_id)
|
||||
default_client_scopes_existing = kc.get_default_client_scopes(realm, client_id)
|
||||
optional_client_scopes_existing = kc.get_optional_client_scopes(realm, client_id)
|
||||
|
||||
result["existing"].update(
|
||||
{
|
||||
"default_clientscopes": extract_field(default_clientscopes_existing),
|
||||
"optional_clientscopes": extract_field(optional_clientscopes_existing),
|
||||
"default_client_scopes": extract_field(default_client_scopes_existing),
|
||||
"optional_client_scopes": extract_field(optional_client_scopes_existing),
|
||||
}
|
||||
)
|
||||
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=normalize_scopes(result["existing"]), after=normalize_scopes(result["proposed"]))
|
||||
|
||||
default_clientscopes_add = clientscopes_to_add(default_clientscopes_existing, default_clientscopes_real)
|
||||
optional_clientscopes_add = clientscopes_to_add(optional_clientscopes_existing, optional_clientscopes_real)
|
||||
default_client_scopes_add = client_scopes_to_add(default_client_scopes_existing, default_client_scopes_real)
|
||||
optional_client_scopes_add = client_scopes_to_add(optional_client_scopes_existing, optional_client_scopes_real)
|
||||
|
||||
default_clientscopes_delete = clientscopes_to_delete(default_clientscopes_existing, default_clientscopes_real)
|
||||
optional_clientscopes_delete = clientscopes_to_delete(optional_clientscopes_existing, optional_clientscopes_real)
|
||||
default_client_scopes_delete = client_scopes_to_delete(default_client_scopes_existing, default_client_scopes_real)
|
||||
optional_client_scopes_delete = client_scopes_to_delete(optional_client_scopes_existing, optional_client_scopes_real)
|
||||
|
||||
result["changed"] = any(
|
||||
len(x) > 0
|
||||
for x in [
|
||||
default_clientscopes_add,
|
||||
optional_clientscopes_add,
|
||||
default_clientscopes_delete,
|
||||
optional_clientscopes_delete,
|
||||
default_client_scopes_add,
|
||||
optional_client_scopes_add,
|
||||
default_client_scopes_delete,
|
||||
optional_client_scopes_delete,
|
||||
]
|
||||
)
|
||||
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
|
||||
# first delete so clientscopes can change type
|
||||
for clientscope in default_clientscopes_delete:
|
||||
kc.delete_default_clientscope(clientscope["id"], realm, client_id)
|
||||
for clientscope in optional_clientscopes_delete:
|
||||
kc.delete_optional_clientscope(clientscope["id"], realm, client_id)
|
||||
# first delete so client_scopes can change type
|
||||
for client_scope in default_client_scopes_delete:
|
||||
kc.delete_default_client_scope(client_scope["id"], realm, client_id)
|
||||
for client_scope in optional_client_scopes_delete:
|
||||
kc.delete_optional_client_scope(client_scope["id"], realm, client_id)
|
||||
|
||||
for clientscope in default_clientscopes_add:
|
||||
kc.add_default_clientscope(clientscope["id"], realm, client_id)
|
||||
for clientscope in optional_clientscopes_add:
|
||||
kc.add_optional_clientscope(clientscope["id"], realm, client_id)
|
||||
for client_scope in default_client_scopes_add:
|
||||
kc.add_default_client_scope(client_scope["id"], realm, client_id)
|
||||
for client_scope in optional_client_scopes_add:
|
||||
kc.add_optional_client_scope(client_scope["id"], realm, client_id)
|
||||
|
||||
result["end_state"].update(
|
||||
{
|
||||
"default_clientscopes": extract_field(kc.get_default_clientscopes(realm, client_id)),
|
||||
"optional_clientscopes": extract_field(kc.get_optional_clientscopes(realm, client_id)),
|
||||
"default_client_scopes": extract_field(kc.get_default_client_scopes(realm, client_id)),
|
||||
"optional_client_scopes": extract_field(kc.get_optional_client_scopes(realm, client_id)),
|
||||
}
|
||||
)
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_clientsecret_info
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_clientsecret_regenerate
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_clienttemplate
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_component
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_component_info
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_group
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_identity_provider
|
||||
@@ -115,6 +117,15 @@ options:
|
||||
- authenticateByDefault
|
||||
type: bool
|
||||
|
||||
hide_on_login:
|
||||
description:
|
||||
- If hidden, login with this provider is possible only if requested explicitly, for example using the C(kc_idp_hint)
|
||||
parameter.
|
||||
aliases:
|
||||
- hideOnLogin
|
||||
- hide_on_login_page
|
||||
type: bool
|
||||
|
||||
provider_id:
|
||||
description:
|
||||
- Protocol used by this provider (supported values are V(oidc) or V(saml)).
|
||||
@@ -129,14 +140,6 @@ options:
|
||||
identity provider configuration through check-mode in the RV(existing) field.
|
||||
type: dict
|
||||
suboptions:
|
||||
hide_on_login_page:
|
||||
description:
|
||||
- If hidden, login with this provider is possible only if requested explicitly, for example using the C(kc_idp_hint)
|
||||
parameter.
|
||||
aliases:
|
||||
- hideOnLoginPage
|
||||
type: bool
|
||||
|
||||
gui_order:
|
||||
description:
|
||||
- Number defining order of the provider in GUI (for example, on Login page).
|
||||
@@ -569,6 +572,7 @@ def main():
|
||||
alias=dict(type="str", required=True),
|
||||
add_read_token_role_on_create=dict(type="bool", aliases=["addReadTokenRoleOnCreate"]),
|
||||
authenticate_by_default=dict(type="bool", aliases=["authenticateByDefault"]),
|
||||
hide_on_login=dict(type="bool", aliases=["hideOnLogin", "hide_on_login_page"]),
|
||||
config=dict(type="dict"),
|
||||
display_name=dict(type="str", aliases=["displayName"]),
|
||||
enabled=dict(type="bool"),
|
||||
@@ -608,6 +612,20 @@ def main():
|
||||
state = module.params.get("state")
|
||||
config = module.params.get("config")
|
||||
|
||||
if config is not None:
|
||||
for legacy_key in ("hide_on_login_page", "hideOnLoginPage"):
|
||||
if legacy_key in config:
|
||||
module.deprecate(
|
||||
f"Passing '{legacy_key}' inside 'config' is deprecated. "
|
||||
"Use the top-level 'hide_on_login' parameter instead.",
|
||||
version="4.0.0",
|
||||
collection_name="middleware_automation.keycloak",
|
||||
)
|
||||
if module.params.get("hide_on_login") is None:
|
||||
module.params["hide_on_login"] = config.pop(legacy_key)
|
||||
else:
|
||||
config.pop(legacy_key)
|
||||
|
||||
fetch_identity_provider_wellknown_config(kc, config)
|
||||
|
||||
# Filter and map the parameters names that apply to the identity provider.
|
||||
|
||||
@@ -0,0 +1,416 @@
|
||||
|
||||
# Copyright (c) 2025, Chris Brown
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_organization
|
||||
|
||||
short_description: Allows administration of Keycloak organizations using Keycloak API
|
||||
|
||||
version_added: "3.1.0"
|
||||
|
||||
description:
|
||||
- This module allows you to add, remove or modify Keycloak organizations 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 U(https://www.keycloak.org/docs-api/latest/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.
|
||||
- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled
|
||||
(C(organizations_enabled=true) in the M(middleware_automation.keycloak.keycloak_realm) module)
|
||||
before this module can be used.
|
||||
- When updating an organization, where possible provide the organization ID to the module. This
|
||||
removes a lookup to the API to translate the name into the organization ID.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: full
|
||||
action_group:
|
||||
version_added: "3.1.0"
|
||||
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- State of the organization.
|
||||
- On V(present), the organization is created if it does not yet exist, or updated with the
|
||||
parameters you provide.
|
||||
- On V(absent), the organization is removed if it exists.
|
||||
default: 'present'
|
||||
type: str
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
|
||||
realm:
|
||||
type: str
|
||||
description:
|
||||
- The Keycloak realm under which this organization resides.
|
||||
default: 'master'
|
||||
|
||||
id:
|
||||
type: str
|
||||
description:
|
||||
- The unique identifier for this organization.
|
||||
- This parameter is not required for updating or deleting an organization but providing it
|
||||
reduces the number of API calls required.
|
||||
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- Name of the organization.
|
||||
- This parameter is required when creating a new organization.
|
||||
|
||||
alias:
|
||||
type: str
|
||||
description:
|
||||
- URL-friendly alias for the organization.
|
||||
- If not provided during creation, defaults to the organization name if URL-safe.
|
||||
- The alias is immutable once set and cannot be changed on update.
|
||||
|
||||
enabled:
|
||||
type: bool
|
||||
description:
|
||||
- Whether the organization is enabled.
|
||||
- Disabled organizations block member authentication.
|
||||
|
||||
description:
|
||||
type: str
|
||||
description:
|
||||
- Description of the organization.
|
||||
|
||||
domains:
|
||||
type: list
|
||||
elements: dict
|
||||
description:
|
||||
- List of internet domains associated with the organization.
|
||||
- A domain name can only belong to one organization within a realm.
|
||||
suboptions:
|
||||
name:
|
||||
type: str
|
||||
required: true
|
||||
description:
|
||||
- The domain name (e.g. V(example.com)).
|
||||
verified:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- Whether the domain has been verified.
|
||||
|
||||
attributes:
|
||||
type: dict
|
||||
description:
|
||||
- A dict of key/value pairs to set as custom attributes for the organization.
|
||||
- Values may be single values (for example a string) or a list of strings.
|
||||
|
||||
extends_documentation_fragment:
|
||||
- middleware_automation.keycloak.keycloak
|
||||
- middleware_automation.keycloak.actiongroup_keycloak
|
||||
- middleware_automation.keycloak.attributes
|
||||
|
||||
author:
|
||||
- Chris Brown (@chribro)
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
- name: Create a Keycloak organization
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
name: my-org
|
||||
description: My Organization
|
||||
enabled: true
|
||||
realm: MyRealm
|
||||
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 organization with domains
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
name: acme-corp
|
||||
description: Acme Corporation
|
||||
enabled: true
|
||||
domains:
|
||||
- name: acme.com
|
||||
- name: acme.org
|
||||
verified: true
|
||||
realm: MyRealm
|
||||
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: Update a Keycloak organization
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
name: my-org
|
||||
description: Updated description
|
||||
realm: MyRealm
|
||||
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: Delete a Keycloak organization
|
||||
middleware_automation.keycloak.keycloak_organization:
|
||||
name: my-org
|
||||
state: absent
|
||||
realm: MyRealm
|
||||
auth_client_id: admin-cli
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_realm: master
|
||||
auth_username: USERNAME
|
||||
auth_password: PASSWORD
|
||||
delegate_to: localhost
|
||||
"""
|
||||
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: Message as to what action was taken.
|
||||
returned: always
|
||||
type: str
|
||||
|
||||
end_state:
|
||||
description: Representation of the organization after module execution.
|
||||
returned: on success
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description: GUID that identifies the organization.
|
||||
type: str
|
||||
returned: always
|
||||
sample: 23f38145-3195-462c-97e7-97041ccea73e
|
||||
name:
|
||||
description: Name of the organization.
|
||||
type: str
|
||||
returned: always
|
||||
sample: my-org
|
||||
alias:
|
||||
description: URL-friendly alias of the organization.
|
||||
type: str
|
||||
returned: always
|
||||
sample: my-org
|
||||
enabled:
|
||||
description: Whether the organization is enabled.
|
||||
type: bool
|
||||
returned: always
|
||||
sample: true
|
||||
description:
|
||||
description: Description of the organization.
|
||||
type: str
|
||||
returned: always
|
||||
sample: My Organization
|
||||
domains:
|
||||
description: Domains associated with the organization.
|
||||
type: list
|
||||
returned: always
|
||||
sample: [{"name": "example.com", "verified": false}]
|
||||
attributes:
|
||||
description: Attributes applied to this organization.
|
||||
type: dict
|
||||
returned: always
|
||||
sample:
|
||||
attr1: ["val1", "val2"]
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
|
||||
KeycloakAPI,
|
||||
KeycloakError,
|
||||
camel,
|
||||
get_token,
|
||||
keycloak_argument_spec,
|
||||
)
|
||||
|
||||
|
||||
def normalise_org(org):
|
||||
"""Normalise an organization representation for comparison.
|
||||
Sorts domains by name to ensure order-independent comparison.
|
||||
"""
|
||||
if org and "domains" in org and org["domains"]:
|
||||
org["domains"] = sorted(org["domains"], key=lambda d: d.get("name", ""))
|
||||
return org
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = keycloak_argument_spec()
|
||||
|
||||
meta_args = dict(
|
||||
state=dict(default="present", choices=["present", "absent"]),
|
||||
realm=dict(default="master"),
|
||||
id=dict(type="str"),
|
||||
name=dict(type="str"),
|
||||
alias=dict(type="str"),
|
||||
enabled=dict(type="bool"),
|
||||
description=dict(type="str"),
|
||||
domains=dict(
|
||||
type="list",
|
||||
elements="dict",
|
||||
options=dict(
|
||||
name=dict(type="str", required=True),
|
||||
verified=dict(type="bool", default=False),
|
||||
),
|
||||
),
|
||||
attributes=dict(type="dict"),
|
||||
)
|
||||
|
||||
argument_spec.update(meta_args)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_one_of=(
|
||||
[
|
||||
["id", "name"],
|
||||
["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"],
|
||||
]
|
||||
),
|
||||
required_together=([["auth_username", "auth_password"]]),
|
||||
required_by={"refresh_token": "auth_realm"},
|
||||
)
|
||||
|
||||
result = dict(changed=False, msg="", diff={}, end_state={})
|
||||
|
||||
try:
|
||||
connection_header = get_token(module.params)
|
||||
except KeycloakError as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
kc = KeycloakAPI(module, connection_header)
|
||||
|
||||
realm = module.params.get("realm")
|
||||
state = module.params.get("state")
|
||||
oid = module.params.get("id")
|
||||
name = module.params.get("name")
|
||||
attributes = module.params.get("attributes")
|
||||
|
||||
if attributes is not None:
|
||||
for key, val in module.params["attributes"].items():
|
||||
module.params["attributes"][key] = [val] if not isinstance(val, list) else val
|
||||
|
||||
# Parameters that map to the organization representation (excluding module-level params)
|
||||
org_params = [
|
||||
x
|
||||
for x in module.params
|
||||
if x not in list(keycloak_argument_spec().keys()) + ["state", "realm"]
|
||||
and module.params.get(x) is not None
|
||||
]
|
||||
|
||||
if oid is None:
|
||||
before_org = kc.get_organization_by_name(name, realm=realm)
|
||||
else:
|
||||
before_org = kc.get_organization_by_id(oid, realm=realm)
|
||||
|
||||
if before_org is None:
|
||||
before_org = {}
|
||||
|
||||
normalise_org(before_org)
|
||||
|
||||
changeset = {}
|
||||
for param in org_params:
|
||||
new_param_value = module.params.get(param)
|
||||
if param == "alias" and before_org:
|
||||
if new_param_value != before_org.get("alias"):
|
||||
module.warn(
|
||||
f"Organization alias is immutable and cannot be changed from '{before_org.get('alias')}' "
|
||||
f"to '{new_param_value}'. The alias parameter will be ignored for this update."
|
||||
)
|
||||
continue
|
||||
old_value = before_org.get(camel(param))
|
||||
if new_param_value != old_value:
|
||||
changeset[camel(param)] = new_param_value
|
||||
|
||||
desired_org = before_org.copy()
|
||||
desired_org.update(changeset)
|
||||
|
||||
normalise_org(desired_org)
|
||||
|
||||
if not before_org:
|
||||
if state == "absent":
|
||||
if module._diff:
|
||||
result["diff"] = dict(before="", after="")
|
||||
result["changed"] = False
|
||||
result["end_state"] = {}
|
||||
result["msg"] = "Organization does not exist; doing nothing."
|
||||
module.exit_json(**result)
|
||||
|
||||
result["changed"] = True
|
||||
|
||||
if name is None:
|
||||
module.fail_json(msg="name must be specified when creating a new organization")
|
||||
|
||||
if module._diff:
|
||||
result["diff"] = dict(before="", after=desired_org)
|
||||
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
|
||||
kc.create_organization(desired_org, realm=realm)
|
||||
|
||||
after_org = kc.get_organization_by_name(name, realm=realm)
|
||||
|
||||
result["end_state"] = normalise_org(after_org) if after_org else {}
|
||||
result["msg"] = f"Organization {name} has been created with ID {after_org['id']}"
|
||||
module.exit_json(**result)
|
||||
|
||||
else:
|
||||
if state == "present":
|
||||
if desired_org == before_org:
|
||||
result["changed"] = False
|
||||
result["end_state"] = desired_org
|
||||
result["msg"] = f"No changes required to organization {before_org['name']}."
|
||||
module.exit_json(**result)
|
||||
|
||||
result["changed"] = True
|
||||
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=before_org, after=desired_org)
|
||||
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
|
||||
kc.update_organization(desired_org, realm=realm)
|
||||
|
||||
after_org = kc.get_organization_by_id(desired_org["id"], realm=realm)
|
||||
|
||||
result["end_state"] = normalise_org(after_org) if after_org else {}
|
||||
result["msg"] = f"Organization {desired_org['id']} has been updated"
|
||||
module.exit_json(**result)
|
||||
|
||||
else:
|
||||
result["changed"] = True
|
||||
|
||||
if module._diff:
|
||||
result["diff"] = dict(before=before_org, after="")
|
||||
|
||||
if module.check_mode:
|
||||
module.exit_json(**result)
|
||||
|
||||
oid = before_org["id"]
|
||||
kc.delete_organization(org_id=oid, realm=realm)
|
||||
|
||||
result["end_state"] = {}
|
||||
result["msg"] = f"Organization {before_org['name']} has been deleted"
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,142 @@
|
||||
|
||||
# Copyright (c) 2025, Chris Brown
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_organization_info
|
||||
|
||||
short_description: Retrieve organization info in Keycloak
|
||||
|
||||
version_added: "3.1.0"
|
||||
|
||||
description:
|
||||
- This module retrieves information on organizations from Keycloak.
|
||||
- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled
|
||||
before this module can be used.
|
||||
attributes:
|
||||
action_group:
|
||||
version_added: "3.1.0"
|
||||
|
||||
options:
|
||||
realm:
|
||||
description:
|
||||
- The name of the realm.
|
||||
required: true
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the organization to search for.
|
||||
- If not provided, all organizations in the realm are returned.
|
||||
type: str
|
||||
exact:
|
||||
description:
|
||||
- Whether the search should be an exact match.
|
||||
- Only relevant when O(name) is provided.
|
||||
type: bool
|
||||
default: true
|
||||
|
||||
extends_documentation_fragment:
|
||||
- middleware_automation.keycloak.keycloak
|
||||
- middleware_automation.keycloak.actiongroup_keycloak
|
||||
- middleware_automation.keycloak.attributes
|
||||
- middleware_automation.keycloak.attributes.info_module
|
||||
|
||||
author:
|
||||
- Chris Brown (@chribro)
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
- name: Retrieve a specific organization by name
|
||||
middleware_automation.keycloak.keycloak_organization_info:
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_username: admin
|
||||
auth_password: password
|
||||
auth_realm: master
|
||||
realm: MyRealm
|
||||
name: my-org
|
||||
|
||||
- name: List all organizations in a realm
|
||||
middleware_automation.keycloak.keycloak_organization_info:
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_username: admin
|
||||
auth_password: password
|
||||
auth_realm: master
|
||||
realm: MyRealm
|
||||
|
||||
- name: Search organizations by partial name
|
||||
middleware_automation.keycloak.keycloak_organization_info:
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
auth_username: admin
|
||||
auth_password: password
|
||||
auth_realm: master
|
||||
realm: MyRealm
|
||||
name: acme
|
||||
exact: false
|
||||
"""
|
||||
|
||||
RETURN = r"""
|
||||
organizations:
|
||||
description: JSON representation of organizations.
|
||||
returned: always
|
||||
type: list
|
||||
elements: dict
|
||||
"""
|
||||
|
||||
from urllib.parse import quote
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
|
||||
KeycloakAPI,
|
||||
KeycloakError,
|
||||
get_token,
|
||||
keycloak_argument_spec,
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = keycloak_argument_spec()
|
||||
|
||||
meta_args = dict(
|
||||
name=dict(type="str"),
|
||||
realm=dict(type="str", required=True),
|
||||
exact=dict(type="bool", default=True),
|
||||
)
|
||||
|
||||
argument_spec.update(meta_args)
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||
|
||||
result = dict(changed=False, organizations=[])
|
||||
|
||||
try:
|
||||
connection_header = get_token(module.params)
|
||||
except KeycloakError as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
kc = KeycloakAPI(module, connection_header)
|
||||
|
||||
realm = module.params.get("realm")
|
||||
name = module.params.get("name")
|
||||
exact = module.params.get("exact")
|
||||
|
||||
filters = []
|
||||
if name:
|
||||
filters.append(f"search={quote(name, safe='')}")
|
||||
if exact:
|
||||
filters.append("exact=true")
|
||||
|
||||
filter_str = "&".join(filters) if filters else None
|
||||
|
||||
result["organizations"] = kc.get_organizations(search_filter=filter_str, realm=realm)
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -4,7 +4,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_realm
|
||||
@@ -422,6 +424,13 @@ options:
|
||||
aliases:
|
||||
- permanentLockout
|
||||
type: bool
|
||||
prune_undefined_realm_attributes:
|
||||
description:
|
||||
- If True all realm attributes which are not defined in the attributes dict will be deleted
|
||||
aliases:
|
||||
- pruneUndefinedRealmAttributes
|
||||
type: bool
|
||||
default: true
|
||||
quick_login_check_milli_seconds:
|
||||
description:
|
||||
- The realm quick login check in milliseconds.
|
||||
@@ -797,6 +806,9 @@ from ansible_collections.middleware_automation.keycloak.plugins.module_utils.ide
|
||||
get_token,
|
||||
keycloak_argument_spec,
|
||||
)
|
||||
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak._keycloak_utils import (
|
||||
merge_settings_without_absent_nulls,
|
||||
)
|
||||
|
||||
|
||||
def normalise_cr(realmrep):
|
||||
@@ -918,6 +930,7 @@ def main():
|
||||
password_policy=dict(type="str", aliases=["passwordPolicy"], no_log=False),
|
||||
organizations_enabled=dict(type="bool", aliases=["organizationsEnabled"]),
|
||||
permanent_lockout=dict(type="bool", aliases=["permanentLockout"]),
|
||||
prune_undefined_realm_attributes=dict(type="bool", aliases=["pruneUndefinedRealmAttributes"], default=True),
|
||||
quick_login_check_milli_seconds=dict(type="int", aliases=["quickLoginCheckMilliSeconds"]),
|
||||
refresh_token_max_reuse=dict(type="int", aliases=["refreshTokenMaxReuse"], no_log=False),
|
||||
registration_allowed=dict(type="bool", aliases=["registrationAllowed"]),
|
||||
@@ -1029,9 +1042,10 @@ def main():
|
||||
|
||||
realm = module.params.get("realm")
|
||||
state = module.params.get("state")
|
||||
prune_undefined_realm_attributes = module.params.get("prune_undefined_realm_attributes")
|
||||
|
||||
# convert module parameters to realm representation parameters (if they belong in there)
|
||||
params_to_ignore = list(keycloak_argument_spec().keys()) + ["state"]
|
||||
params_to_ignore = list(keycloak_argument_spec().keys()) + ["state", "prune_undefined_realm_attributes"]
|
||||
|
||||
# Filter and map the parameters names that apply to the role
|
||||
realm_params = [x for x in module.params if x not in params_to_ignore and module.params.get(x) is not None]
|
||||
@@ -1047,6 +1061,9 @@ def main():
|
||||
|
||||
for realm_param in realm_params:
|
||||
new_param_value = module.params.get(realm_param)
|
||||
if camel(realm_param) == "attributes" and not prune_undefined_realm_attributes:
|
||||
new_param_value = merge_settings_without_absent_nulls(before_realm.get("attributes"), new_param_value)
|
||||
|
||||
changeset[camel(realm_param)] = new_param_value
|
||||
|
||||
# Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_realm_info
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_realm_key
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_realm_keys_metadata_info
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_realm_localization
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_realm_rolemapping
|
||||
|
||||
@@ -0,0 +1,123 @@
|
||||
#!/usr/bin/python
|
||||
|
||||
# Copyright (c) Ansible project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_realm_users_info
|
||||
|
||||
short_description: Retrieve users from a Keycloak realm using the Keycloak API
|
||||
|
||||
# Originally added in community.general 13.1.0
|
||||
version_added: "3.1.0"
|
||||
|
||||
description:
|
||||
- This module retrieves all users from a specified Keycloak realm using the Keycloak REST API.
|
||||
- Access to the REST API is performed via OpenID Connect. The user and client used must have the necessary permissions.
|
||||
- Authentication can be performed either with username/password or with a token.
|
||||
- The names of module options are snake_case versions of the camelCase ones found in the Keycloak API and its documentation
|
||||
at U(https://www.keycloak.org/docs-api/latest/rest-api/index.html).
|
||||
|
||||
options:
|
||||
realm:
|
||||
type: str
|
||||
description:
|
||||
- The Keycloak realm from which users should be retrieved.
|
||||
default: 'master'
|
||||
|
||||
extends_documentation_fragment:
|
||||
- middleware_automation.keycloak.keycloak
|
||||
- middleware_automation.keycloak.actiongroup_keycloak
|
||||
- middleware_automation.keycloak.attributes
|
||||
- middleware_automation.keycloak.attributes.info_module
|
||||
|
||||
author:
|
||||
- Felix Grzelka (@felix-grzelka)
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
- name: List all users in the "MyCustomRealm" realm using username/password authentication
|
||||
middleware_automation.keycloak.keycloak_realm_users_info:
|
||||
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: List all users in the "MyCustomRealm" realm using a token
|
||||
middleware_automation.keycloak.keycloak_realm_users_info:
|
||||
realm: MyCustomRealm
|
||||
auth_client_id: admin-cli
|
||||
auth_keycloak_url: https://auth.example.com
|
||||
token: TOKEN
|
||||
delegate_to: localhost
|
||||
"""
|
||||
|
||||
RETURN = r"""
|
||||
users:
|
||||
description: List of users in the specified realm.
|
||||
returned: always
|
||||
type: list
|
||||
elements: dict
|
||||
sample:
|
||||
- id: "1234-5678-90"
|
||||
username: "user1"
|
||||
email: "user1@example.com"
|
||||
- id: "2345-6789-01"
|
||||
username: "user2"
|
||||
email: "user2@example.com"
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
|
||||
KeycloakAPI,
|
||||
KeycloakError,
|
||||
get_token,
|
||||
keycloak_argument_spec,
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = keycloak_argument_spec()
|
||||
|
||||
meta_args = dict(
|
||||
realm=dict(default="master"),
|
||||
)
|
||||
argument_spec.update(meta_args)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_one_of=(
|
||||
[["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"]]
|
||||
),
|
||||
required_together=([["auth_username", "auth_password"]]),
|
||||
required_by={"refresh_token": "auth_realm"},
|
||||
)
|
||||
|
||||
result = dict(changed=False, msg="", users="")
|
||||
|
||||
# Obtain access token, initialize API
|
||||
try:
|
||||
connection_header = get_token(module.params)
|
||||
except KeycloakError as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
kc = KeycloakAPI(module, connection_header)
|
||||
|
||||
realm = module.params.get("realm")
|
||||
|
||||
result["users"] = kc.get_realm_users(realm=realm)
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_role
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_user
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_user_execute_actions_email
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_user_federation
|
||||
|
||||
@@ -2,7 +2,9 @@
|
||||
# Copyright (c) 2022, Dušan Marković (@bratwurzt)
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_user_rolemapping
|
||||
|
||||
@@ -3,7 +3,9 @@
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
from __future__ import annotations
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
module: keycloak_userprofile
|
||||
|
||||
@@ -2,4 +2,14 @@
|
||||
collections:
|
||||
- name: middleware_automation.common
|
||||
version: ">=1.2.4"
|
||||
- name: middleware_automation.infinispan
|
||||
- name: community.general
|
||||
- name: ansible.posix
|
||||
- name: community.docker
|
||||
version: ">=3.8.0"
|
||||
- name: containers.podman
|
||||
version: ">=1.8.1"
|
||||
|
||||
roles:
|
||||
- name: elan.simple_nginx_reverse_proxy
|
||||
version: "0.2.1"
|
||||
|
||||
@@ -388,6 +388,6 @@ argument_specs:
|
||||
description: "Red Hat SSO patch archive filename"
|
||||
type: "str"
|
||||
sso_product_category:
|
||||
default: "core.service.rhsso"
|
||||
description: "JBossNetwork API category for Single Sign-On"
|
||||
default: "CORE.SERVICE.RHSSO"
|
||||
description: "Unified Downloads API category for Single Sign-On"
|
||||
type: "str"
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
- name: "Check if packages are already installed" # noqa command-instead-of-module this runs faster
|
||||
ansible.builtin.command: "rpm -q {{ packages_list | join(' ') }}"
|
||||
register: rpm_info
|
||||
register: keycloak_rpm_info
|
||||
changed_when: false
|
||||
failed_when: false
|
||||
when: ansible_facts.os_family == "RedHat"
|
||||
|
||||
- name: "Add missing packages to the yum install list"
|
||||
ansible.builtin.set_fact:
|
||||
packages_to_install: "{{ packages_to_install | default([]) + rpm_info.stdout_lines | \
|
||||
keycloak_packages_to_install: "{{ keycloak_packages_to_install | default([]) + keycloak_rpm_info.stdout_lines | \
|
||||
map('regex_findall', 'package (.+) is not installed$') | default([]) | flatten }}"
|
||||
when: ansible_facts.os_family == "RedHat"
|
||||
|
||||
- name: "Install packages: {{ packages_to_install }}"
|
||||
- name: "Install packages: {{ keycloak_packages_to_install }}"
|
||||
become: "{{ keycloak_fastpackages_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.dnf:
|
||||
name: "{{ packages_to_install }}"
|
||||
name: "{{ keycloak_packages_to_install }}"
|
||||
state: present
|
||||
when:
|
||||
- packages_to_install | default([]) | length > 0
|
||||
- keycloak_packages_to_install | default([]) | length > 0
|
||||
- ansible_facts.os_family == "RedHat"
|
||||
|
||||
- name: "Install packages: {{ packages_list }}"
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
enabled: true
|
||||
state: started
|
||||
|
||||
- name: "Configure firewall ports for {{ keycloak.service_name }}"
|
||||
- name: "Configure firewall ports for {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_firewalld_require_privilege_escalation | default(true) }}"
|
||||
ansible.posix.firewalld:
|
||||
port: "{{ item }}"
|
||||
|
||||
@@ -14,18 +14,18 @@
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.stat:
|
||||
path: "{{ keycloak_jboss_home }}"
|
||||
register: existing_deploy
|
||||
register: keycloak_existing_deploy
|
||||
|
||||
- name: Stop and restart if existing deployment exists and install forced
|
||||
when: existing_deploy.stat.exists and keycloak_force_install | bool
|
||||
when: keycloak_existing_deploy.stat.exists and keycloak_force_install | bool
|
||||
block:
|
||||
- name: "Stop the old {{ keycloak.service_name }} service"
|
||||
- name: "Stop the old service: {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
failed_when: false
|
||||
ansible.builtin.systemd:
|
||||
name: keycloak
|
||||
state: stopped
|
||||
- name: "Remove the old {{ keycloak.service_name }} deployment"
|
||||
- name: "Remove the old deployment: {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.file:
|
||||
path: "{{ keycloak_jboss_home }}"
|
||||
@@ -36,7 +36,7 @@
|
||||
ansible.builtin.stat:
|
||||
path: "{{ keycloak_jboss_home }}"
|
||||
|
||||
- name: "Create service user/group for {{ keycloak.service_name }}"
|
||||
- name: "Create service user/group for {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.user:
|
||||
name: "{{ keycloak_service_user }}"
|
||||
@@ -44,7 +44,7 @@
|
||||
system: true
|
||||
create_home: false
|
||||
|
||||
- name: "Create install location for {{ keycloak.service_name }}"
|
||||
- name: "Create install location for {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.file:
|
||||
dest: "{{ keycloak_dest }}"
|
||||
@@ -65,34 +65,35 @@
|
||||
## check remote archive
|
||||
- name: Set download archive path
|
||||
ansible.builtin.set_fact:
|
||||
archive: "{{ keycloak_dest }}/{{ keycloak.bundle }}"
|
||||
keycloak_archive_full_path: "{{ keycloak_dest }}/{{ keycloak_archive }}"
|
||||
|
||||
- name: Check download archive path
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.stat:
|
||||
path: "{{ archive }}"
|
||||
register: archive_path
|
||||
path: "{{ keycloak_archive_full_path }}"
|
||||
register: keycloak_archive_path
|
||||
|
||||
## download to controller
|
||||
- name: Check local download archive path
|
||||
ansible.builtin.stat:
|
||||
path: "{{ lookup('env', 'PWD') }}"
|
||||
register: local_path
|
||||
register: keycloak_local_path
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Download keycloak archive
|
||||
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
|
||||
url: "{{ keycloak_download_url }}"
|
||||
dest: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
|
||||
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
||||
mode: '0644'
|
||||
url_username: "{{ keycloak_binary_download_user | default(omit) }}"
|
||||
url_password: "{{ keycloak_binary_download_pass | default(omit) }}"
|
||||
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
when:
|
||||
- archive_path is defined
|
||||
- archive_path.stat is defined
|
||||
- not archive_path.stat.exists
|
||||
- keycloak_archive_path is defined
|
||||
- keycloak_archive_path.stat is defined
|
||||
- not keycloak_archive_path.stat.exists
|
||||
- not sso_enable is defined or not sso_enable
|
||||
- not keycloak_offline_install
|
||||
|
||||
@@ -100,9 +101,9 @@
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
when:
|
||||
- archive_path is defined
|
||||
- archive_path.stat is defined
|
||||
- not archive_path.stat.exists
|
||||
- keycloak_archive_path is defined
|
||||
- keycloak_archive_path.stat is defined
|
||||
- not keycloak_archive_path.stat.exists
|
||||
- sso_enable is defined and sso_enable
|
||||
- not keycloak_offline_install
|
||||
block:
|
||||
@@ -113,14 +114,18 @@
|
||||
product_type: DISTRIBUTION
|
||||
product_version: "{{ sso_version.split('.')[:2] | join('.') }}"
|
||||
product_category: "{{ sso_product_category }}"
|
||||
register: rhn_products
|
||||
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||
register: keycloak_rhn_products
|
||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
|
||||
- name: Determine install zipfile from search results
|
||||
ansible.builtin.set_fact:
|
||||
rhn_filtered_products: "{{ rhn_products.results | selectattr('file_name', 'match', '[^/]*/' + sso_archive + '$') }}"
|
||||
keycloak_rhn_filtered_products: >-
|
||||
{{ keycloak_rhn_products.results
|
||||
| selectattr('file_name', 'search', 'rh-sso-' + sso_version + '-server-dist.zip$')
|
||||
| list }}
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
|
||||
@@ -128,8 +133,9 @@
|
||||
middleware_automation.common.product_download: # noqa risky-file-permissions delegated, uses controller host user
|
||||
client_id: "{{ rhn_username }}"
|
||||
client_secret: "{{ rhn_password }}"
|
||||
product_id: "{{ (rhn_filtered_products | first).id }}"
|
||||
dest: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
|
||||
product_id: "{{ (keycloak_rhn_filtered_products | first).id }}"
|
||||
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
||||
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||
no_log: "{{ omit_rhn_output | default(true) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
@@ -137,68 +143,69 @@
|
||||
- name: Download rhsso archive from alternate location
|
||||
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
|
||||
url: "{{ keycloak_rhsso_download_url }}"
|
||||
dest: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
|
||||
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
||||
mode: '0644'
|
||||
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
|
||||
delegate_to: localhost
|
||||
run_once: true
|
||||
when:
|
||||
- archive_path is defined
|
||||
- archive_path.stat is defined
|
||||
- not archive_path.stat.exists
|
||||
- keycloak_archive_path is defined
|
||||
- keycloak_archive_path.stat is defined
|
||||
- not keycloak_archive_path.stat.exists
|
||||
- sso_enable is defined and sso_enable
|
||||
- not keycloak_offline_install
|
||||
- keycloak_rhsso_download_url is defined
|
||||
|
||||
- name: Check downloaded archive
|
||||
ansible.builtin.stat:
|
||||
path: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
|
||||
register: local_archive_path
|
||||
path: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
||||
register: keycloak_local_archive_path
|
||||
delegate_to: localhost
|
||||
|
||||
## copy and unpack
|
||||
- name: Copy archive to target nodes
|
||||
ansible.builtin.copy:
|
||||
src: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
|
||||
dest: "{{ archive }}"
|
||||
src: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
|
||||
dest: "{{ keycloak_archive_full_path }}"
|
||||
owner: "{{ keycloak_service_user }}"
|
||||
group: "{{ keycloak_service_group }}"
|
||||
mode: '0640'
|
||||
register: new_version_downloaded
|
||||
register: keycloak_new_version_downloaded
|
||||
when:
|
||||
- not archive_path.stat.exists
|
||||
- local_archive_path.stat is defined
|
||||
- local_archive_path.stat.exists
|
||||
- not keycloak_archive_path.stat.exists
|
||||
- keycloak_local_archive_path.stat is defined
|
||||
- keycloak_local_archive_path.stat.exists
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
|
||||
- name: "Check target directory: {{ keycloak.home }}"
|
||||
- name: "Check target directory: {{ keycloak_config.home }}"
|
||||
ansible.builtin.stat:
|
||||
path: "{{ keycloak.home }}"
|
||||
register: path_to_workdir
|
||||
path: "{{ keycloak_config.home }}"
|
||||
register: keycloak_path_to_workdir
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
|
||||
- name: "Extract {{ keycloak_service_desc }} archive on target"
|
||||
- name: "Extract archive on target: {{ keycloak_service_desc }}"
|
||||
ansible.builtin.unarchive:
|
||||
remote_src: true
|
||||
src: "{{ archive }}"
|
||||
src: "{{ keycloak_archive_full_path }}"
|
||||
dest: "{{ keycloak_dest }}"
|
||||
creates: "{{ keycloak.home }}"
|
||||
creates: "{{ keycloak_config.home }}"
|
||||
owner: "{{ keycloak_service_user }}"
|
||||
group: "{{ keycloak_service_group }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
when:
|
||||
- new_version_downloaded.changed or not path_to_workdir.stat.exists
|
||||
- keycloak_new_version_downloaded.changed or not keycloak_path_to_workdir.stat.exists
|
||||
notify:
|
||||
- restart keycloak
|
||||
|
||||
- name: Inform decompression was not executed
|
||||
ansible.builtin.debug:
|
||||
msg: "{{ keycloak.home }} already exists and version unchanged, skipping decompression"
|
||||
msg: "{{ keycloak_config.home }} already exists and version unchanged, skipping decompression"
|
||||
when:
|
||||
- not new_version_downloaded.changed and path_to_workdir.stat.exists
|
||||
- not keycloak_new_version_downloaded.changed and keycloak_path_to_workdir.stat.exists
|
||||
|
||||
- name: "Reown installation directory to {{ keycloak_service_user }}"
|
||||
ansible.builtin.file:
|
||||
path: "{{ keycloak.home }}"
|
||||
path: "{{ keycloak_config.home }}"
|
||||
owner: "{{ keycloak_service_user }}"
|
||||
group: "{{ keycloak_service_group }}"
|
||||
recurse: true
|
||||
@@ -206,17 +213,17 @@
|
||||
changed_when: false
|
||||
|
||||
- name: Ensure permissions are correct on existing deploy
|
||||
ansible.builtin.command: chown -R "{{ keycloak_service_user }}:{{ keycloak_service_group }}" "{{ keycloak.home }}"
|
||||
ansible.builtin.command: chown -R "{{ keycloak_service_user }}:{{ keycloak_service_group }}" "{{ keycloak_config.home }}"
|
||||
when: keycloak_service_runas
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
changed_when: false
|
||||
|
||||
# driver and configuration
|
||||
- name: "Install {{ keycloak_jdbc_engine }} driver"
|
||||
- name: "Install database driver: {{ keycloak_jdbc_engine }}"
|
||||
ansible.builtin.include_tasks: jdbc_driver.yml
|
||||
when: keycloak_jdbc[keycloak_jdbc_engine].enabled
|
||||
|
||||
- name: "Deploy custom {{ keycloak.service_name }} config to {{ keycloak_config_path_to_standalone_xml }} from {{ keycloak_config_override_template }}"
|
||||
- name: "Deploy custom config: {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.template:
|
||||
src: "templates/{{ keycloak_config_override_template }}"
|
||||
@@ -226,9 +233,9 @@
|
||||
mode: '0640'
|
||||
notify:
|
||||
- restart keycloak
|
||||
when: keycloak_config_override_template | length > 0
|
||||
when: (keycloak_config_override_template | default('', true)) | length > 0
|
||||
|
||||
- name: "Deploy standalone {{ keycloak.service_name }} config to {{ keycloak_config_path_to_standalone_xml }}"
|
||||
- name: "Deploy standalone config: {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.template:
|
||||
src: templates/standalone.xml.j2
|
||||
@@ -240,7 +247,7 @@
|
||||
- restart keycloak
|
||||
when:
|
||||
- not keycloak_ha_enabled
|
||||
- keycloak_config_override_template | length == 0
|
||||
- (keycloak_config_override_template | default('', true)) | length == 0
|
||||
|
||||
- name: Create tcpping cluster node list
|
||||
ansible.builtin.set_fact:
|
||||
@@ -256,7 +263,7 @@
|
||||
loop: "{{ ansible_play_batch }}"
|
||||
when: keycloak_ha_enabled and keycloak_ha_discovery == 'TCPPING'
|
||||
|
||||
- name: "Deploy HA {{ keycloak.service_name }} config to {{ keycloak_config_path_to_standalone_xml }}"
|
||||
- name: "Deploy HA config: {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.template:
|
||||
src: templates/standalone-ha.xml.j2
|
||||
@@ -269,9 +276,9 @@
|
||||
when:
|
||||
- keycloak_ha_enabled
|
||||
- not keycloak_remote_cache_enabled
|
||||
- keycloak_config_override_template | length == 0
|
||||
- (keycloak_config_override_template | default('', true)) | length == 0
|
||||
|
||||
- name: "Deploy HA {{ keycloak.service_name }} config with infinispan remote cache store to {{ keycloak_config_path_to_standalone_xml }}"
|
||||
- name: "Deploy HA config with infinispan: {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.template:
|
||||
src: templates/standalone-infinispan.xml.j2
|
||||
@@ -284,7 +291,7 @@
|
||||
when:
|
||||
- keycloak_ha_enabled
|
||||
- keycloak_remote_cache_enabled
|
||||
- keycloak_config_override_template | length == 0
|
||||
- (keycloak_config_override_template | default('', true)) | length == 0
|
||||
|
||||
- name: "Deploy profile.properties file to {{ keycloak_config_path_to_properties }}"
|
||||
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
|
||||
@@ -296,4 +303,4 @@
|
||||
mode: '0640'
|
||||
notify:
|
||||
- restart keycloak
|
||||
when: keycloak_features | length > 0
|
||||
when: (keycloak_features | default([], true)) | length > 0
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
packages_list:
|
||||
- iptables
|
||||
|
||||
- name: "Configure firewall ports for {{ keycloak.service_name }}"
|
||||
- name: "Configure firewall ports for {{ keycloak_config.service_name }}"
|
||||
become: "{{ keycloak_iptables_require_privilege_escalation | default(true) }}"
|
||||
ansible.builtin.iptables:
|
||||
destination_port: "{{ item }}"
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
- name: "Check module directory: {{ keycloak_jdbc[keycloak_jdbc_engine].driver_module_dir }}"
|
||||
ansible.builtin.stat:
|
||||
path: "{{ keycloak_jdbc[keycloak_jdbc_engine].driver_module_dir }}"
|
||||
register: dest_path
|
||||
register: keycloak_dest_path
|
||||
become: "{{ keycloak_jdbc_driver_require_privilege_escalation | default(true) }}"
|
||||
|
||||
- name: "Set up module dir for JDBC Driver {{ keycloak_jdbc[keycloak_jdbc_engine].driver_module_name }}"
|
||||
|
||||
@@ -60,13 +60,13 @@
|
||||
url: "{{ keycloak_url }}/auth/realms/master/protocol/openid-connect/token"
|
||||
method: POST
|
||||
body: "client_id={{ keycloak_auth_client }}&username={{ keycloak_admin_user }}&password={{ keycloak_admin_password }}&grant_type=password"
|
||||
validate_certs: false
|
||||
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||
register: keycloak_auth_response
|
||||
until: keycloak_auth_response.status == 200
|
||||
retries: 2
|
||||
delay: 2
|
||||
rescue:
|
||||
- name: "Create {{ keycloak.service_name }} admin user"
|
||||
- name: "Create admin user: {{ keycloak_config.service_name }}"
|
||||
ansible.builtin.command:
|
||||
args:
|
||||
argv:
|
||||
@@ -76,11 +76,12 @@
|
||||
- "-p{{ keycloak_admin_password }}"
|
||||
changed_when: true
|
||||
become: "{{ keycloak_require_privilege_escalation | default(true) }}"
|
||||
- name: "Restart {{ keycloak.service_name }}"
|
||||
- name: "Restart service: {{ keycloak_config.service_name }}"
|
||||
ansible.builtin.include_tasks: tasks/restart_keycloak.yml
|
||||
- name: "Wait until {{ keycloak.service_name }} becomes active {{ keycloak.health_url }}"
|
||||
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
||||
ansible.builtin.uri:
|
||||
url: "{{ keycloak.health_url }}"
|
||||
url: "{{ keycloak_config.health_url }}"
|
||||
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||
register: keycloak_status
|
||||
until: keycloak_status.status == 200
|
||||
retries: 25
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
- name: Validate admin console password
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- keycloak_admin_password | length > 12
|
||||
- (keycloak_admin_password | default('', true)) | length > 12
|
||||
quiet: true
|
||||
fail_msg: >
|
||||
The console administrator password is empty or invalid. Please set the keycloak_admin_password variable to a 12+ char long string
|
||||
@@ -31,9 +31,9 @@
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- keycloak_jdbc_engine is defined and keycloak_jdbc_engine in [ 'postgres', 'mariadb', 'sqlserver' ]
|
||||
- keycloak_jdbc_url | length > 0
|
||||
- keycloak_db_user | length > 0
|
||||
- keycloak_db_pass | length > 0
|
||||
- (keycloak_jdbc_url | default('', true)) | length > 0
|
||||
- (keycloak_db_user | default('', true)) | length > 0
|
||||
- (keycloak_db_pass | default('', true)) | length > 0
|
||||
quiet: true
|
||||
fail_msg: "Configuration for the JDBC persistence is invalid or incomplete"
|
||||
success_msg: "Configuring JDBC persistence using {{ keycloak_jdbc_engine }} database"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
- name: "Restart and enable {{ keycloak.service_name }} service"
|
||||
- name: "Restart and enable service: {{ keycloak_config.service_name }}"
|
||||
ansible.builtin.systemd:
|
||||
name: keycloak
|
||||
enabled: true
|
||||
@@ -9,9 +9,10 @@
|
||||
delegate_to: "{{ ansible_play_hosts | first }}"
|
||||
run_once: true
|
||||
|
||||
- name: "Wait until {{ keycloak.service_name }} becomes active {{ keycloak.health_url }}"
|
||||
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
|
||||
ansible.builtin.uri:
|
||||
url: "{{ keycloak.health_url }}"
|
||||
url: "{{ keycloak_config.health_url }}"
|
||||
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
|
||||
register: keycloak_status
|
||||
until: keycloak_status.status == 200
|
||||
delegate_to: "{{ ansible_play_hosts | first }}"
|
||||
@@ -19,7 +20,7 @@
|
||||
retries: "{{ keycloak_service_start_retries }}"
|
||||
delay: "{{ keycloak_service_start_delay }}"
|
||||
|
||||
- name: "Restart and enable {{ keycloak.service_name }} service"
|
||||
- name: "Restart and enable service (remaining nodes): {{ keycloak_config.service_name }}"
|
||||
ansible.builtin.systemd:
|
||||
name: keycloak
|
||||
enabled: true
|
||||
|
||||
@@ -8,6 +8,6 @@
|
||||
|
||||
- name: "Execute CLI query: {{ cli_query }}"
|
||||
ansible.builtin.command: >
|
||||
{{ keycloak.cli_path }} --connect --command='{{ cli_query }}' --controller={{ keycloak_host }}:{{ keycloak_management_http_port }}
|
||||
{{ keycloak_config.cli_path }} --connect --command='{{ cli_query }}' --controller={{ keycloak_host }}:{{ keycloak_management_http_port }}
|
||||
changed_when: false
|
||||
register: cli_result
|
||||
register: keycloak_cli_result
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user