Compare commits

..
73 Commits
Author SHA1 Message Date
ansible-middleware-core 3e4587ec69 Bump version to 3.1.3 2026-10-09 14:58:26 +00:00
Harsha CherukuriandGitHub 7793ecd381 Merge pull request #437 from ansible-middleware/changelog/3.1.2
Update changelog for release 3.1.2
2026-10-09 10:56:59 -04:00
ansible-middleware-core 5cd7f3d147 Update changelog for release 3.1.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-10-09 14:40:59 +00:00
Harsha CherukuriandGitHub 39721dff35 Merge pull request #436 from cihlamar/AMW-649
Add missing protocolMappers alias to keycloak_client_scope mo…
2026-10-09 10:39:29 -04:00
Harsha CherukuriandGitHub 6c2ab1e4b9 Merge pull request #409 from cihlamar/AMW-616
Port integration tests from community.general
2026-10-09 10:38:58 -04:00
Martin Cihlar 3218326ac3 AMW-649 Add missing protocolMappers alias to keycloak_client_scope module
The keycloak_client module accepts protocolMappers as an alias for
protocol_mappers, but keycloak_client_scope was missing it.

Fixes #435
2026-10-09 10:53:47 +02:00
Martin Cihlar c51f290d64 AMW-616 Port 24 community.general keycloak integration tests to molecule
Port integration tests from community.general keycloak modules into
the keycloak collection molecule test framework (keycloak_modules
scenario), adapting for KC 26.x behavioral changes and middleware
module differences.

Ported modules: keycloak_authentication, keycloak_authz_authorization_scope,
keycloak_authz_permission, keycloak_client, keycloak_client_rolescope,
keycloak_client_scope_rolemappings, keycloak_client_scope_type,
keycloak_clientsecret_info, keycloak_clientsecret_regenerate,
keycloak_component_info, keycloak_group, keycloak_group_rolemapping,
keycloak_identity_provider, keycloak_modules_authentication,
keycloak_realm, keycloak_realm_key, keycloak_realm_users_info,
keycloak_role, keycloak_user, keycloak_user_federation,
keycloak_user_rolemapping, keycloak_userprofile.

KC 26.x adaptations:
- serviceAccountsEnabled defaults to true on new clients
- Default Policy/Resource no longer auto-created for authz clients
- Built-in admin role rejects PUT updates (403)
- Invalid credentials return HTTP 400 instead of 401
- LDAP federation no longer auto-creates mappers

Other fixes:
- Variable collision avoidance (role/group/client register overwriting
  play-level vars via include_vars)
- Ansible 2.19+ native Jinja dict handling (endpoint combine filter)
- Jinja embedded template warnings in assert expressions
- Auth fallback prevention in invalid-token tests
2026-10-08 20:48:09 +02:00
Ranabir ChakrabortyandGitHub bcddd1b95b Merge pull request #434 from cihlamar/AMW-641 2026-10-06 16:58:52 +05:30
Martin Cihlar e43dcafa9d AMW-641 Clarify health_check_url_path description per review 2026-10-06 10:42:18 +02:00
Harsha CherukuriandGitHub 3f620aaeba Merge pull request #429 from cihlamar/AMW-641
Fix health check URL to use localhost with protocol and port
2026-10-05 19:22:06 -04:00
Harsha CherukuriandGitHub e070def764 Merge pull request #433 from RanabirChakraborty/AMW-644
AMW-644 keycloak_user_federation module always reports task as changed in check mode
2026-10-05 19:18:50 -04:00
Ranabir Chakraborty ed99d28b5d AMW-644 keycloak_user_federation module always reports task as changed in check mode 2026-10-05 19:40:06 +05:30
Martin Cihlar 3e82ac6461 AMW-641 Fix health check URL to use localhost instead of public hostname
Replace hostname-based health check URL with localhost. The health check
runs on the managed host itself, so it should always target localhost
rather than the public-facing keycloak_quarkus_hostname which can be
empty or a domain name behind a load balancer.

Compose the URL directly from existing production variables
(keycloak_quarkus_http_enabled, keycloak_quarkus_http_port,
keycloak_quarkus_https_port, keycloak_quarkus_http_relative_path)
without introducing intermediate variables.

Add .config/molecule/config.yml with shared molecule settings and a new
quarkus_nohost test scenario that verifies the role works when
keycloak_quarkus_hostname is left at its default empty value.

Fixes #428
2026-10-05 15:24:02 +02:00
Harsha CherukuriandGitHub 4b317c46de Merge pull request #430 from RanabirChakraborty/AMW-642
AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature
2026-10-01 06:41:16 -04:00
Ranabir Chakraborty bd2c01a588 AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature 2026-10-01 00:55:27 +05:30
Harsha CherukuriandGitHub 221b1a7667 Merge pull request #425 from hcherukuri/main
Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND
2026-09-21 08:15:22 -04:00
Harsha Cherukuri d4fea4a5be Fix quarkus molecule verify for JAVA_OPTS sysconfig 2026-09-18 09:30:58 -04:00
Harsha CherukuriandGitHub 8c8eef172d Merge pull request #427 from ansible-middleware/bump/3.1.2
Bump version to 3.1.2
2026-09-18 08:58:33 -04:00
ansible-middleware-core 3b89e5a154 Bump version to 3.1.2 2026-09-18 12:53:05 +00:00
Harsha CherukuriandGitHub a1ed36e919 Merge pull request #426 from ansible-middleware/changelog/3.1.1
Update changelog for release 3.1.1
2026-09-18 08:50:47 -04:00
ansible-middleware-core 37e96d9bc0 Update changelog for release 3.1.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-09-18 12:32:53 +00:00
Harsha Cherukuri 8a3ed80b04 Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND 2026-09-17 11:15:47 -04:00
Harsha CherukuriandGitHub d8d36a41a8 Merge pull request #422 from Maestro157/bump/keycloak-26.7.3
Bump Keycloak to 26.7.3 and RHBK to 26.4.15
2026-09-17 08:47:54 -04:00
Harsha CherukuriandGitHub e8031923af Merge pull request #424 from cihlamar/AMW-634
Fix keycloak_quarkus_health_check_url crash when hostname is unset
2026-09-17 08:44:23 -04:00
Harsha CherukuriandGitHub eee2472cd6 Merge pull request #419 from nwintering/main
Add support for the `description` attribute of keycloak groups
2026-09-17 08:43:33 -04:00
Martin Cihlar 45e91f4e3f Fix keycloak_quarkus_health_check_url crash when hostname is unset
Default keycloak_quarkus_hostname to empty string instead of null to
prevent AttributeError when .rstrip() is called on NoneType in the
health_check_url default expression.

Fixes #423
2026-09-17 11:58:29 +02:00
Stefan Krempel f3b484acdd Bump Keycloak to 26.7.3 and RHBK to 26.4.15
Update the keycloak_quarkus role defaults, argument specs, README and
molecule scenarios to the current upstream releases. Keycloak 26.7.2+
and RHBK 26.4.15 fix CVE-2026-18963 (GHSA-4gv3-mc9p-5wqc, CVSS 9.1).

- keycloak_quarkus_version: 26.6.2 -> 26.7.3
- rhbk_version: 26.4.11 -> 26.4.15
- molecule/quarkus: SPID provider 26.5.6 -> 26.7.1 (new sha256),
  keycloak-kerberos-federation 26.6.3 -> 26.7.3
- molecule/quarkus_upgrade: prepare on 26.6.2, converge to 26.7.3

JDBC driver defaults are left unchanged; they still match the versions
listed in Red Hat article 7033107 referenced from the defaults file.
2026-09-15 15:39:42 +02:00
nwintering 7d9e99b370 add missing dot to docu 2026-09-14 16:57:38 +02:00
nwinteringandGitHub 2b4ce2694c Merge branch 'ansible-middleware:main' into main 2026-09-14 16:49:19 +02:00
Harsha CherukuriandGitHub 44e3f0078f Merge pull request #418 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-5.0.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 4.1.0 to 5.0.0
2026-09-14 08:57:53 -04:00
dependabot[bot]andGitHub 034a3bac52 Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
Bumps [ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml](https://github.com/ansible-collections/partner-certification-checker) from 4.1.0 to 5.0.0.
- [Release notes](https://github.com/ansible-collections/partner-certification-checker/releases)
- [Changelog](https://github.com/ansible-collections/partner-certification-checker/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/ansible-collections/partner-certification-checker/compare/f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e...fefb6b967e99964b55665b66ef0d8e4148d84aca)

---
updated-dependencies:
- dependency-name: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-09-14 12:46:56 +00:00
nwintering 2bb6946fb9 Add support for description attribute 2026-09-14 14:44:35 +02:00
Ranabir ChakrabortyandGitHub 48d014cb18 Merge pull request #417 from ansible-middleware/bump/3.1.1
Bump version to 3.1.1
2026-09-11 22:13:53 +05:30
ansible-middleware-core 0fb476c6a1 Bump version to 3.1.1 2026-09-11 15:08:05 +00:00
Ranabir ChakrabortyandGitHub a071cd1c2d Merge pull request #416 from RanabirChakraborty/changelog/3.1.0
Update changelog for release 3.1.0
2026-09-11 20:34:19 +05:30
ansible-middleware-coreandRanabir Chakraborty 6b2d4a8552 Update changelog for release 3.1.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-09-11 20:29:58 +05:30
Ranabir ChakrabortyandGitHub 08ee1c33bc Merge pull request #412 from cihlamar/AMW-628
Replace deprecated top-level fact variables with ansible_fact
2026-09-11 20:01:40 +05:30
Ranabir ChakrabortyandGitHub e103524781 Merge pull request #384 from NilsBergmann/feature/authv2-formaction
authentication_v2: Fix validation for FormActions
2026-09-11 20:00:09 +05:30
Ranabir ChakrabortyandGitHub 45863b3023 Merge pull request #414 from hcherukuri/main
Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in
2026-09-11 12:44:16 +05:30
Ranabir ChakrabortyandGitHub 9ac8274434 Merge pull request #413 from cihlamar/AMW-578
Replace deprecated community.general.yaml callback with result
2026-09-10 21:07:57 +05:30
Harsha Cherukuri 0716f622ad Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in 2026-09-10 09:03:29 -04:00
Harsha CherukuriandGitHub 14cba062b4 Merge pull request #411 from RanabirChakraborty/AMW-626
AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role
2026-09-10 08:57:52 -04:00
Martin Cihlar 9d56a54bd8 AMW-628 Replace deprecated top-level fact variables with ansible_facts syntax 2026-09-10 13:26:02 +02:00
Martin Cihlar 8c3c4d8cbc AMW-578 Replace deprecated community.general.yaml callback with result_format 2026-09-10 10:38:00 +02:00
Nils Bergmann 638f694120 authentication_v2: Fix validation for form-flows and client-flows 2026-09-09 10:36:56 +02:00
Ranabir Chakraborty 86bd6c77d6 AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role 2026-09-09 13:24:37 +05:30
Ranabir ChakrabortyandGitHub 6644207e5d Merge pull request #407 from Yabk/bugfix/keycloak_group_parents
keycloak_group: fix subgroup lookup on Keycloak older than 25
2026-09-09 12:40:51 +05:30
Ranabir ChakrabortyandGitHub 5ba8098c15 Merge pull request #408 from cihlamar/AMW-625
Add use_netrc option to prevent .netrc overriding bearer token
2026-09-09 12:33:09 +05:30
Martin Cihlar d6ceb63914 AMW-625 add use_netrc option to prevent .netrc overriding bearer token auth
When ~/.netrc contains an entry matching the Keycloak host, open_url()
silently replaces the OIDC Bearer header with Basic auth, causing 401
errors. Add use_netrc option (default false) to all keycloak modules
and pass it through to both open_url() call sites.

Includes molecule test scenario (netrc) that verifies both behaviors:
- default use_netrc=false ignores .netrc (fix works)
- use_netrc=true picks up .netrc and gets 401 (proves the bug)

Fixes: https://github.com/ansible-middleware/keycloak/issues/403
2026-09-07 09:09:39 +02:00
Yabk 529b667321 keycloak_group: fix subgroup lookup on Keycloak older than 25
The parents branch of get_group_by_name() queried
GET /admin/realms/{realm}/groups/{id}/children?search=&exact=true
unconditionally. That endpoint only accepts GET from Keycloak 23 on, so
older servers (RH-SSO 7.x included) failed with 405 Method Not Allowed,
and 23/24 ignore search/exact and return only the first 10 children, so
subgroups past the tenth were silently reported as absent.

The lookup now goes through get_subgroups(), which already detects the
server generation, and that helper takes an optional search argument so
the search optimization is kept where the server supports it.
2026-09-04 12:56:23 +02:00
Harsha CherukuriandGitHub 8d5526aeb6 Merge pull request #406 from RanabirChakraborty/AMW-622
AMW-622 keycloak collection spelling and grammar checking for PRs
2026-09-03 13:48:04 -04:00
Ranabir ChakrabortyandGitHub afc12b6ae2 Merge pull request #405 from hcherukuri/main
Fix issue #397 #398 crash on first role assignment
2026-09-03 22:34:37 +05:30
Ranabir Chakraborty 0868b58e90 AMW-622 keycloak collection spelling and grammar checking for PRs 2026-09-03 22:18:47 +05:30
Harsha Cherukuri 2ffe3a8f7b Fix keycloak_user_federation for issue #398 2026-09-03 10:02:35 -04:00
Harsha CherukuriandGitHub 6814939116 Merge pull request #402 from stblassitude/fix/keycloak_authentication_v2-subflow-keyerror
In a flow definition, handle non-existing keys correctly
2026-09-03 09:47:01 -04:00
Harsha Cherukuri 24350903ed Fix issue #397 crash on first role assignment 2026-09-03 09:43:17 -04:00
Harsha CherukuriandGitHub 89cb1691ae Merge pull request #404 from hcherukuri/main
Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
2026-09-03 09:38:14 -04:00
Harsha Cherukuri 79852e61fc Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter 2026-09-03 08:23:38 -04:00
Stefan Bethke 8007d8039a Handle non-existing keys correctly
See issue #401 for details.
2026-09-02 10:35:01 +02:00
Ranabir ChakrabortyandGitHub 85d494731a Merge pull request #399 from santanoce/bugfix/keycloak_user
keycloak_user: fix attributes always reporting changed=True
2026-09-01 18:43:41 +05:30
Ranabir ChakrabortyandGitHub d41fc161be Merge pull request #392 from cihlamar/AMW-612
Normalize hostname that includes http_relative_path suffix
2026-09-01 18:42:10 +05:30
Harsha CherukuriandGitHub 4e1d14c4a1 Merge pull request #400 from RanabirChakraborty/AMW-615
AMW-615 Inconsistent support of authentication via client credentials
2026-08-31 22:34:42 -04:00
Ranabir Chakraborty e9f74fa4a9 AMW-615 Inconsistent support of authentication via client credentials 2026-08-31 23:40:02 +05:30
santanoce 23d96186f5 keycloak_user: fix attributes always reporting changed=True 2026-08-30 12:44:17 +02:00
Martin Cihlar b48b0b7334 AMW-612 Fix health URL duplication when hostname includes http_relative_path
Use removesuffix to strip overlapping path from hostname before
re-appending http_relative_path, preventing /auth/auth/ duplication.
Add molecule test for the relative path scenario.
2026-08-27 13:14:28 +02:00
Martin CihlarandGitHub 9446e53b6e Merge pull request #393 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-4.1.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 4.0.0 to 4.1.0
2026-08-27 11:50:45 +02:00
Ranabir ChakrabortyandGitHub a29e1a0c0e Merge pull request #387 from ansible-middleware/dependabot/github_actions/EndBug/add-and-commit-11
Bump EndBug/add-and-commit from 10 to 11
2026-08-26 22:45:27 +05:30
Ranabir ChakrabortyandGitHub f082e8adb1 Merge pull request #374 from RISE-GmbH/369-add_integration_tests_for_keycloak_authentication_v2
369 add integration tests for keycloak_authentication_v2
2026-08-26 22:45:08 +05:30
Ranabir ChakrabortyandGitHub a4cdf1b154 Merge pull request #395 from ansible-middleware/bump/3.0.12
Bump version to 3.0.12
2026-08-24 22:40:30 +05:30
ansible-middleware-core 4112ac7d71 Bump version to 3.0.12 2026-08-24 17:08:25 +00:00
dependabot[bot]andGitHub 8021fd735d Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
Bumps [ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml](https://github.com/ansible-collections/partner-certification-checker) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/ansible-collections/partner-certification-checker/releases)
- [Changelog](https://github.com/ansible-collections/partner-certification-checker/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/ansible-collections/partner-certification-checker/compare/f182febf0568baf1151f66549401167fd10b25d2...f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e)

---
updated-dependencies:
- dependency-name: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
  dependency-version: 4.1.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-24 12:45:47 +00:00
dependabot[bot]andGitHub 3d9c71a2e6 Bump EndBug/add-and-commit from 10 to 11
Bumps [EndBug/add-and-commit](https://github.com/endbug/add-and-commit) from 10 to 11.
- [Release notes](https://github.com/endbug/add-and-commit/releases)
- [Commits](https://github.com/endbug/add-and-commit/compare/v10...v11)

---
updated-dependencies:
- dependency-name: EndBug/add-and-commit
  dependency-version: '11'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-17 12:46:38 +00:00
Thomas Bargetz 742c44039c 369 add integration tests for keycloak_authentication_v2 2026-08-17 07:40:31 +02:00
116 changed files with 8046 additions and 255 deletions
+104
View File
@@ -0,0 +1,104 @@
# Keycloak / Ansible domain-specific words
# Only terms NOT covered by built-in dictionaries
# Product names and projects
Infinispan
infinispan
Wildfly
wildfly
keycloak
# Red Hat product names
RHBK
rhbk
rhsso
# Java / JBoss terms
Djboss
Djgroups
Dsun
ispn
ISPN
jaegertracing
jaxrs
jberet
JDBCPING
jgroups
JGROUPSPING
jndi
keytool
MPING
NAKACK
passivation
passivating
slsb
sfsb
TCPPING
tcpping
jdbcx
cacerts
changeit
# Systemd directives
restartsec
runas
startlimitburst
systemdunit
# Ansible terms
fqcn
FQCN
# WildFly / JBoss terms
jbcs
modcluster
# Linux / System terms
firewalld
cgroupns
zgrep
# Configuration terms
xforwarded
PYTHONHTTPSVERIFY
# Keycloak-specific
ciba
clusterless
eddsa
multivalued
remembertochangeme
subcomponent
subcomponents
# Molecule / Testing
hspaans
# CI / DevOps
sangonzal
rootperm
# RST / Sphinx directives
toctree
# Task names / verbs
Reown
decomment
# British spellings (from upstream Keycloak docs)
recognises
# Integration test container/variable names
Ceciestes
myidpfromurl
myidprealm
myfed
myldap
rootgrp
subgrp
subsubgrp
subsubsubgrp
Untestes
# Other
rmaster
+1 -1
View File
@@ -22,4 +22,4 @@ concurrency:
# 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
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@fefb6b967e99964b55665b66ef0d8e4148d84aca # v5.0.0
+13 -1
View File
@@ -14,6 +14,18 @@ on:
- cron: '15 6 * * *'
jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v7
- name: Run cspell
uses: streetsidesoftware/cspell-action@v9
with:
incremental_files_only: false
use_cspell_files: true
ci:
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
secrets: inherit
@@ -22,4 +34,4 @@ jobs:
root_permission_varname: 'keycloak_install_requires_become'
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
molecule_tests: >-
[ "debian", "sso_test", "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", "quarkus_relpath", "quarkus_nohost" ]
+1 -1
View File
@@ -18,7 +18,7 @@ jobs:
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
- name: Commit changes
uses: EndBug/add-and-commit@v10
uses: EndBug/add-and-commit@v11
with:
author_name: Ansible Middleware
message: "GitHub traffic"
+56
View File
@@ -6,6 +6,62 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
v3.1.2
======
Major Changes
-------------
- Port integration tests from community.general `#409 <https://github.com/ansible-middleware/keycloak/pull/409>`_
Minor Changes
-------------
- AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature `#430 <https://github.com/ansible-middleware/keycloak/pull/430>`_
- AMW-644 keycloak_user_federation module always reports task as changed in check mode `#433 <https://github.com/ansible-middleware/keycloak/pull/433>`_
Bugfixes
--------
- Fix health check URL to use localhost with protocol and port `#429 <https://github.com/ansible-middleware/keycloak/pull/429>`_
- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND `#425 <https://github.com/ansible-middleware/keycloak/pull/425>`_
v3.1.1
======
Minor Changes
-------------
- Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
- Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
Bugfixes
--------
- Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424 <https://github.com/ansible-middleware/keycloak/pull/424>`_
v3.1.0
======
Minor Changes
-------------
- 369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
- AMW-578 Replace deprecated community.general.yaml callback with result `#413 <https://github.com/ansible-middleware/keycloak/pull/413>`_
- AMW-615 Inconsistent support of authentication via client credentials `#400 <https://github.com/ansible-middleware/keycloak/pull/400>`_
- AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
- Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter `#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
- Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
- In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
- Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
- Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
- authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
- keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
- keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
v3.0.11
=======
+1 -1
View File
@@ -10,7 +10,7 @@ Clone the repository, checkout the tag you want to build, or pick the main branc
### Development environment
Make sure your development machine has avilable:
Make sure your development machine has available:
* python 3.11+
* virtualenv
+119
View File
@@ -891,3 +891,122 @@ releases:
fragments:
- 344.yaml
release_date: '2026-06-11'
3.1.0:
changes:
minor_changes:
- '369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
'
- 'AMW-578 Replace deprecated community.general.yaml callback with result `#413
<https://github.com/ansible-middleware/keycloak/pull/413>`_
'
- 'AMW-615 Inconsistent support of authentication via client credentials `#400
<https://github.com/ansible-middleware/keycloak/pull/400>`_
'
- 'AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
'
- 'AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable
Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
'
- 'Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
'
- 'Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
`#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
'
- 'Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified
mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
'
- 'Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
'
- 'In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
'
- 'Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
'
- 'Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
'
- 'authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
'
- 'keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
'
- 'keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
'
fragments:
- 374.yaml
- 384.yaml
- 392.yaml
- 399.yaml
- 400.yaml
- 402.yaml
- 404.yaml
- 405.yaml
- 406.yaml
- 407.yaml
- 408.yaml
- 411.yaml
- 412.yaml
- 413.yaml
- 414.yaml
release_date: '2026-09-11'
3.1.1:
changes:
bugfixes:
- 'Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424
<https://github.com/ansible-middleware/keycloak/pull/424>`_
'
minor_changes:
- 'Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
'
- 'Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
'
fragments:
- 419.yaml
- 422.yaml
- 424.yaml
release_date: '2026-09-18'
3.1.2:
changes:
bugfixes:
- 'Fix health check URL to use localhost with protocol and port `#429 <https://github.com/ansible-middleware/keycloak/pull/429>`_
'
- 'Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP
and JAVA_OPTS_APPEND `#425 <https://github.com/ansible-middleware/keycloak/pull/425>`_
'
major_changes:
- 'Port integration tests from community.general `#409 <https://github.com/ansible-middleware/keycloak/pull/409>`_
'
minor_changes:
- 'AMW-642 keycloak_identity_provider: add support for Do not store users from
transient-users feature `#430 <https://github.com/ansible-middleware/keycloak/pull/430>`_
'
- 'AMW-644 keycloak_user_federation module always reports task as changed in
check mode `#433 <https://github.com/ansible-middleware/keycloak/pull/433>`_
'
fragments:
- 409.yaml
- 425.yaml
- 429.yaml
- 430.yaml
- 433.yaml
release_date: '2026-10-09'
+59
View File
@@ -0,0 +1,59 @@
{
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
"version": "0.2",
"language": "en",
"ignorePaths": ["changelogs/**", "CHANGELOG.rst"],
"files": [
"**/*.md",
"**/*.rst",
"roles/*/meta/argument_specs.yml",
"roles/*/meta/main.yml",
"roles/*/tasks/**/*.yml",
"roles/*/defaults/*.yml",
"roles/*/handlers/*.yml",
"roles/*/templates/*.j2",
"molecule/**/*.yml",
"molecule/**/*.j2",
"playbooks/**/*.yml",
"meta/runtime.yml",
"meta/execution-environment.yml",
".github/workflows/*.yml",
".github/ISSUE_TEMPLATE/*.md",
"galaxy.yml"
],
"dictionaries": [
"custom-keycloak",
"java",
"bash",
"shellscript",
"fullstack",
"softwareTerms",
"software-tools",
"cpp-compound-words",
"python",
"docker",
"k8s",
"html",
"css",
"git",
"networking-terms",
"node",
"npm"
],
"dictionaryDefinitions": [
{
"name": "custom-keycloak",
"path": ".cspell/custom-dictionary.txt",
"addWords": true
}
],
"ignoreRegExpList": [
"/\\{\\{.*?\\}\\}/g",
"/`[^`]+`/g",
"/(https?:\\/\\/[^\\s)]+)/g",
"/\\|`?[a-z_]+`?\\|/g",
"/\\[.*?\\]\\(.*?\\)/g",
"/^\\s*authors?:.*$/gm",
"/^\\s*-\\s+.*<[^>]+>.*$/gm"
]
}
+2 -1
View File
@@ -1,11 +1,12 @@
---
namespace: middleware_automation
name: keycloak
version: "3.0.11"
version: "3.1.3"
readme: README.md
authors:
- Romain Pelisse <rpelisse@redhat.com>
- Guido Grazioli <ggraziol@redhat.com>
- Ranabir Chakraborty <ranabir@ibm.com>
- Pavan Kumar Motaparthi <pmotapar@redhat.com>
- Helmut Wolf <hwo@world-direct.at>
- Harsha Cherukuri <hcheruku@redhat.com>
+11 -8
View File
@@ -1,17 +1,20 @@
v3.0.11
=======
v3.1.2
======
Major Changes
-------------
- Port integration tests from community.general #409
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
- AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature #430
- AMW-644 keycloak_user_federation module always reports task as changed in check mode #433
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
- Fix health check URL to use localhost with protocol and port #429
- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND #425
+4 -4
View File
@@ -20,7 +20,7 @@
- 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.6.2/keycloak-26.6.2.zip
url: https://github.com/keycloak/keycloak/releases/download/26.7.3/keycloak-26.7.3.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
@@ -38,7 +38,7 @@
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_type: DISTRIBUTION
product_version: "{{ keycloak_quarkus_version | default('26.6.2') }}"
product_version: "{{ keycloak_quarkus_version | default('26.7.3') }}"
product_category: "RHBK"
register: rhn_products
no_log: "{{ omit_rhn_output | default(true) }}"
@@ -48,7 +48,7 @@
- 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$') }}"
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.7.3')) + '.zip$') }}"
delegate_to: localhost
run_once: true
when:
@@ -60,7 +60,7 @@
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"
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.7.3') }}.zip"
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
@@ -0,0 +1,131 @@
---
# Ported from community.general tests/integration/targets/keycloak_authentication
# Tests authentication flow CRUD: create from copy, create with conditional OTP,
# update config, verify config uniqueness via realm export, and delete.
- name: Set auth flow test variables
ansible.builtin.set_fact:
keycloak_no_otp_required_pattern_original: 'X-Forwarded-For: 10\.[0-9\.:]+'
keycloak_no_otp_required_pattern_modified: 'X-Original-Forwarded-For: 10\.[0-9\.:]+'
- name: Create auth flow from first broker login copy
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "Test first broker login"
copyFrom: "first broker login"
authenticationExecutions:
- providerId: "idp-review-profile"
requirement: "REQUIRED"
authenticationConfig:
alias: "Test review profile config"
config:
update.profile.on.first.login: "missing"
- name: Create conditional OTP auth flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
description: "browser based authentication with otp"
providerId: "basic-flow"
authenticationExecutions:
- displayName: Cookie
providerId: auth-cookie
requirement: ALTERNATIVE
- displayName: Kerberos
providerId: auth-spnego
requirement: DISABLED
- displayName: Identity Provider Redirector
providerId: identity-provider-redirector
requirement: ALTERNATIVE
- displayName: My browser otp forms
requirement: ALTERNATIVE
- displayName: Username Password Form
flowAlias: My browser otp forms
providerId: auth-username-password-form
requirement: REQUIRED
- displayName: My browser otp Browser - Conditional OTP
flowAlias: My browser otp forms
requirement: REQUIRED
providerId: "auth-conditional-otp-form"
authenticationConfig:
alias: my-conditional-otp-config
config:
defaultOtpOutcome: "force"
noOtpRequiredForHeaderPattern: "{{ keycloak_no_otp_required_pattern_original }}"
state: present
- name: Update conditional OTP auth flow config
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
description: "browser based authentication with otp"
providerId: "basic-flow"
authenticationExecutions:
- displayName: Cookie
providerId: auth-cookie
requirement: ALTERNATIVE
- displayName: Kerberos
providerId: auth-spnego
requirement: DISABLED
- displayName: Identity Provider Redirector
providerId: identity-provider-redirector
requirement: ALTERNATIVE
- displayName: My browser otp forms
requirement: ALTERNATIVE
- displayName: Username Password Form
flowAlias: My browser otp forms
providerId: auth-username-password-form
requirement: REQUIRED
- displayName: My browser otp Browser - Conditional OTP
flowAlias: My browser otp forms
requirement: REQUIRED
providerId: "auth-conditional-otp-form"
authenticationConfig:
alias: my-conditional-otp-config
config:
defaultOtpOutcome: "force"
noOtpRequiredForHeaderPattern: "{{ keycloak_no_otp_required_pattern_modified }}"
state: present
register: result
- name: Get access token for realm export
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
status_code: 200
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
- name: Extract access token
ansible.builtin.set_fact:
access_token: "{{ token_response.json.access_token }}"
- name: Export ephemeral realm
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ ephemeral_realm }}/partial-export?exportClients=false&exportGroupsAndRoles=false"
method: POST
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
body_format: form-urlencoded
body: {}
register: exported_realm
no_log: true
- name: Assert my-conditional-otp-config exists only once
ansible.builtin.assert:
that:
- exported_realm.json.authenticatorConfig | selectattr('alias', 'equalto', 'my-conditional-otp-config') | list | length == 1
- name: Delete conditional OTP auth flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
state: absent
register: result
@@ -0,0 +1,24 @@
# 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
- name: Get access token
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
status_code: 200
headers:
Accept: application/json
User-agent: Ansible
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
no_log: true
- name: Extract access token
ansible.builtin.set_fact:
access_token: "{{ token_response.json['access_token'] }}"
no_log: true
@@ -0,0 +1,37 @@
# 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
- name: Flow Creation/Update <Integration Test Flow> Version 1
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: idp-create-user-if-unique
requirement: ALTERNATIVE
authenticationConfig:
alias: Integration Test Flow - create unique user config
config:
require.password.update.after.registration: "false"
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: idp-confirm-link
requirement: REQUIRED
- providerId: auth-cookie
requirement: REQUIRED
register: flow_v1_result
- name: Expose flow_v1_result to parent scope
ansible.builtin.set_fact:
flow_v1_result: "{{ flow_v1_result }}"
no_log: true
@@ -0,0 +1,43 @@
# 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
# - adding a new execution inside the sub flow 'Integration Test Flow - User creation or linking' after the execution 'idp-create-user-if-unique'
# - disable auth-cookie at the end of the flow
# - change the config require.password.update.after.registration to "true"
- name: Flow Creation/Update <Integration Test Flow> Version 2
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: idp-create-user-if-unique
requirement: ALTERNATIVE
authenticationConfig:
alias: Integration Test Flow - create unique user config
config:
require.password.update.after.registration: "true"
- providerId: auth-cookie
requirement: REQUIRED
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: idp-confirm-link
requirement: REQUIRED
- providerId: auth-cookie
requirement: DISABLED
register: flow_v2_result
- name: Expose flow_v2_result to parent scope
ansible.builtin.set_fact:
flow_v2_result: "{{ flow_v2_result }}"
no_log: true
@@ -0,0 +1,28 @@
# 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
# Rebuilds Keycloak's own built-in "clients" flow structure as of 26.7.1.
# validate_executions() used to raise a KeyError for client-flow parents, since only
# basic-flow and form-flow provider sets were known.
- name: Flow Creation/Update <Integration Test Flow - Client Flow>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Client Flow
providerId: client-flow
state: present
authenticationExecutions:
- providerId: client-secret
requirement: ALTERNATIVE
- providerId: client-jwt
requirement: ALTERNATIVE
- providerId: client-secret-jwt
requirement: ALTERNATIVE
- providerId: client-x509
requirement: ALTERNATIVE
register: flow_v2_client_flow_result
- name: Expose flow_v2_client_flow_result to parent scope
ansible.builtin.set_fact:
flow_v2_client_flow_result: "{{ flow_v2_client_flow_result }}"
no_log: true
@@ -0,0 +1,31 @@
# 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
# Rebuilds Keycloak's own built-in "registration" flow structure as of 26.7.1.
# validate_executions() used to only check authenticator-providers and falsely flagged form actions as invalid
# See https://github.com/ansible-middleware/keycloak/issues/382
- name: Flow Creation/Update <Integration Test Flow - Form Actions>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Form Actions
state: present
authenticationExecutions:
- subFlow: Integration Test Flow - Form Actions - registration form
subFlowType: form-flow
requirement: REQUIRED
authenticationExecutions:
- providerId: registration-user-creation
requirement: REQUIRED
- providerId: registration-password-action
requirement: REQUIRED
- providerId: registration-recaptcha-action
requirement: DISABLED
- providerId: registration-terms-and-conditions
requirement: DISABLED
register: flow_v2_form_action_result
- name: Expose flow_v2_form_action_result to parent scope
ansible.builtin.set_fact:
flow_v2_form_action_result: "{{ flow_v2_form_action_result }}"
no_log: true
@@ -0,0 +1,144 @@
# 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
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 6
- test_flow_executions.json[0].providerId == "idp-review-profile"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].priority == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationConfig is not none
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].priority == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[1]['authenticationConfig'] is not defined
- test_flow_executions.json[1].authenticationFlow == true
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 0
- test_flow_executions.json[2].priority == 0
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[2].authenticationConfig is not none
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
- test_flow_executions.json[3].displayName == "Integration Test Flow - Handle Existing Account"
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
- test_flow_executions.json[3].index == 1
- test_flow_executions.json[3].priority == 1
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[3]['authenticationConfig'] is not defined
- test_flow_executions.json[3].authenticationFlow == true
- test_flow_executions.json[4].providerId == "idp-confirm-link"
- test_flow_executions.json[4].requirement == "REQUIRED"
- test_flow_executions.json[4].index == 0
- test_flow_executions.json[4].priority == 0
- test_flow_executions.json[4].level == 2
- test_flow_executions.json[4]['authenticationConfig'] is not defined
- test_flow_executions.json[4]['authenticationFlow'] is not defined or test_flow_executions.json[4].authenticationFlow == false
- test_flow_executions.json[5].providerId == "auth-cookie"
- test_flow_executions.json[5].requirement == "REQUIRED"
- test_flow_executions.json[5].index == 2
- test_flow_executions.json[5].priority == 2
- test_flow_executions.json[5].level == 0
- test_flow_executions.json[5]['authenticationConfig'] is not defined
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
- name: Fetch flow execution config for 'idp-review-profile'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_review_profile_config
no_log: true
- name: Assert flow execution config for 'idp-review-profile'
ansible.builtin.assert:
that:
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
- test_flow_execution_idp_review_profile_config.json.config is not none
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
- name: Fetch flow execution config for 'idp-create-user-if-unique'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_create_user_if_unique
no_log: true
- name: Assert flow execution config for 'idp-create-user-if-unique'
ansible.builtin.assert:
that:
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
- test_flow_execution_idp_create_user_if_unique.json.config is not none
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "false"
@@ -0,0 +1,151 @@
# 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
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 7
- test_flow_executions.json[0].providerId == "idp-review-profile"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].priority == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationConfig is not none
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].priority == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[1]['authenticationConfig'] is not defined
- test_flow_executions.json[1].authenticationFlow == true
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 0
- test_flow_executions.json[2].priority == 0
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[2].authenticationConfig is not none
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
- test_flow_executions.json[3].providerId == "auth-cookie"
- test_flow_executions.json[3].requirement == "REQUIRED"
- test_flow_executions.json[3].index == 1
- test_flow_executions.json[3].priority == 1
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[3]['authenticationConfig'] is not defined
- test_flow_executions.json[3]['authenticationFlow'] is not defined or test_flow_executions.json[3].authenticationFlow == false
- test_flow_executions.json[4].displayName == "Integration Test Flow - Handle Existing Account"
- test_flow_executions.json[4].requirement == "ALTERNATIVE"
- test_flow_executions.json[4].index == 2
- test_flow_executions.json[4].priority == 2
- test_flow_executions.json[4].level == 1
- test_flow_executions.json[4]['authenticationConfig'] is not defined
- test_flow_executions.json[4].authenticationFlow == true
- test_flow_executions.json[5].providerId == "idp-confirm-link"
- test_flow_executions.json[5].requirement == "REQUIRED"
- test_flow_executions.json[5].index == 0
- test_flow_executions.json[5].priority == 0
- test_flow_executions.json[5].level == 2
- test_flow_executions.json[5]['authenticationConfig'] is not defined
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
- test_flow_executions.json[6].providerId == "auth-cookie"
- test_flow_executions.json[6].requirement == "DISABLED"
- test_flow_executions.json[6].index == 2
- test_flow_executions.json[6].priority == 2
- test_flow_executions.json[6].level == 0
- test_flow_executions.json[6]['authenticationConfig'] is not defined
- test_flow_executions.json[6]['authenticationFlow'] is not defined or test_flow_executions.json[6].authenticationFlow == false
- name: Fetch flow execution config for 'idp-review-profile'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_review_profile_config
no_log: true
- name: Assert flow execution config for 'idp-review-profile'
ansible.builtin.assert:
that:
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
- test_flow_execution_idp_review_profile_config.json.config is not none
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
- name: Fetch flow execution config for 'idp-create-user-if-unique'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_create_user_if_unique
no_log: true
- name: Assert flow execution config for 'idp-create-user-if-unique'
ansible.builtin.assert:
that:
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
- test_flow_execution_idp_create_user_if_unique.json.config is not none
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "true"
@@ -0,0 +1,80 @@
# 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
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow - Client Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow - Client Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow - Client Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow - Client Flow"
- test_flow_top_level_data.json.providerId == "client-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow - Client Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Client%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 4
- test_flow_executions.json[0].providerId == "client-secret"
- test_flow_executions.json[0].requirement == "ALTERNATIVE"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[1].providerId == "client-jwt"
- test_flow_executions.json[1].requirement == "ALTERNATIVE"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[2].providerId == "client-secret-jwt"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 2
- test_flow_executions.json[2].level == 0
- test_flow_executions.json[3].providerId == "client-x509"
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
- test_flow_executions.json[3].index == 3
- test_flow_executions.json[3].level == 0
@@ -0,0 +1,86 @@
# 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
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow - Form Actions'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow - Form Actions')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow - Form Actions'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow - Form Actions"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow - Form Actions'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Form%20Actions/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 5
- test_flow_executions.json[0].displayName == "Integration Test Flow - Form Actions - registration form"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationFlow == true
- test_flow_executions.json[1].providerId == "registration-user-creation"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 0
- test_flow_executions.json[1].level == 1
- test_flow_executions.json[1]['authenticationFlow'] is not defined or test_flow_executions.json[1].authenticationFlow == false
- test_flow_executions.json[2].providerId == "registration-password-action"
- test_flow_executions.json[2].requirement == "REQUIRED"
- test_flow_executions.json[2].index == 1
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[3].providerId == "registration-recaptcha-action"
- test_flow_executions.json[3].requirement == "DISABLED"
- test_flow_executions.json[3].index == 2
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[4].providerId == "registration-terms-and-conditions"
- test_flow_executions.json[4].requirement == "DISABLED"
- test_flow_executions.json[4].index == 3
- test_flow_executions.json[4].level == 1
@@ -0,0 +1,33 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow - Client Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v2_client_flow.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v2_client_flow_result is changed
- flow_v2_client_flow_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow - Client Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2_client_flow.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow - Client Flow> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v2_client_flow.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v2_client_flow_result is not changed
- flow_v2_client_flow_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
@@ -0,0 +1,61 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Create a client with browser override <Integration Test Flow>
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: present
authentication_flow_binding_overrides:
browser_name: "Integration Test Flow"
- name: Modify the flow <Integration Test Flow> although it is bound as client override flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch client data
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: present
register: client_result
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch authentication flow (browser override={{ client_result.end_state.authenticationFlowBindingOverrides.browser }})
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ client_result.end_state.authenticationFlowBindingOverrides.browser }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: flow_response
- name: Assert client flow override binding
ansible.builtin.assert:
that:
- flow_response.json is defined
- flow_response.json.alias == "Integration Test Flow"
@@ -0,0 +1,33 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v1_result is changed
- flow_v1_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v1.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v1_result is not changed
- flow_v1_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
@@ -0,0 +1,40 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Delete the flow <Integration Test Flow>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: absent
register: flow_deletion_result
- name: Assert that the flow deletion result
ansible.builtin.assert:
that:
- flow_deletion_result is changed
- flow_deletion_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_deletion_result.changed }}, diff={{ flow_deletion_result.get('diff') }}"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow does not exist anymore
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,33 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow - Form Actions>
ansible.builtin.include_tasks:
file: ../actions/flow_v2_form_action.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v2_form_action_result is changed
- flow_v2_form_action_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow - Form Actions>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2_form_action.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow - Form Actions> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v2_form_action.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v2_form_action_result is not changed
- flow_v2_form_action_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
@@ -0,0 +1,58 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Create an identity-provider with first and post login flow override <Integration Test Flow>
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: present
display_name: OpenID Connect IdP - Integration Test
enabled: true
provider_id: oidc
first_broker_login_flow_alias: Integration Test Flow
post_broker_login_flow_alias: Integration Test Flow
config:
issuer: https://idp.example.com
authorizationUrl: https://idp.example.com/auth
tokenUrl: https://idp.example.com/token
userInfoUrl: https://idp.example.com/userinfo
clientAuthMethod: client_secret_post
clientId: my-client
clientSecret: secret
syncMode: FORCE
- name: Modify the flow <Integration Test Flow> although it is bound as identity-provider first and post login flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch identity-provider data
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: present
register: identity_provider_result
- name: Assert identity-provider first and post flow binding
ansible.builtin.assert:
that:
- identity_provider_result.end_state.firstBrokerLoginFlowAlias == "Integration Test Flow"
- identity_provider_result.end_state.postBrokerLoginFlowAlias == "Integration Test Flow"
@@ -0,0 +1,58 @@
# 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
---
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Flow Creation/Update <Integration Test Flow with invalid providerid in execution>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow with invalid providerid in execution
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: invalid-providerid
requirement: ALTERNATIVE
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: another-invalid-providerid
requirement: REQUIRED
- providerId: auth-cookie
requirement: REQUIRED
ignore_errors: true
register: invalid_providerid_in_flow_result
- name: Verify that invalid providerId causes failure
ansible.builtin.assert:
that:
- invalid_providerid_in_flow_result is failed
- invalid_providerid_in_flow_result is not changed
- >-
invalid_providerid_in_flow_result.msg == "Validation of executions failed: Error(s) while validating flow: Unknown providerId 'invalid-providerid', Unknown providerId 'another-invalid-providerid'"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow did not get created
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20with%20invalid%20providerid%20in%20execution/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,50 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
# form-action providers are valid for form-flow, but not for basic-flow.
# This test ensures that validate_executions() correctly rejects them when used in a basic-flow context.
# Same for authentication providers (e.g auth-cookie) in a form-flow context.
- name: Flow Creation/Update <Integration Test Flow - Mismatched Flow Type> with providerIds mismatched to their parent flow type
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Mismatched Flow Type
state: present
authenticationExecutions:
- providerId: registration-user-creation
requirement: REQUIRED
- subFlow: Integration Test Flow - Mismatched Flow Type - form
subFlowType: form-flow
requirement: REQUIRED
authenticationExecutions:
- providerId: auth-cookie
requirement: REQUIRED
ignore_errors: true
register: mismatched_flow_type_result
- name: Assert providerIds mismatched with their parent flow type are rejected
ansible.builtin.assert:
that:
- mismatched_flow_type_result is failed
- mismatched_flow_type_result is not changed
- "'registration-user-creation' in mismatched_flow_type_result.msg"
- "'auth-cookie' in mismatched_flow_type_result.msg"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow did not get created
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Mismatched%20Flow%20Type/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,45 @@
# 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
- name: Delete identity-provider <oidc-idp-integration-test> if it exists
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: absent
- name: Delete client <test_client> if it exists
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: absent
- name: Unassign the flow <Integration Test Flow> as default browser flow
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
browser_flow: browser
- name: Delete <Integration Test Flow> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: absent
- name: Delete <Integration Test Flow - Form Actions> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Form Actions
state: absent
- name: Delete <Integration Test Flow - Mismatched Flow Type> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Mismatched Flow Type
state: absent
- name: Delete <Integration Test Flow - Client Flow> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Client Flow
state: absent
@@ -0,0 +1,41 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Modify the flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow creation modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the modified flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
# Revert the modifications from the previous step
- name: Revert the modifications the flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v1_result is changed
- flow_v1_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after reverting the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v1.yml
@@ -0,0 +1,44 @@
# 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
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assign the flow <Integration Test Flow> as default browser flow
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
browser_flow: Integration Test Flow
- name: Modify the flow <Integration Test Flow> although it is bound as realm browser flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch realm data to validate if the browser flow is still set to <Integration Test Flow>
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
register: realm_result
- name: Assert realm browser flow binding
ansible.builtin.assert:
that:
- realm_result.end_state.browserFlow == "Integration Test Flow"
@@ -0,0 +1,39 @@
- name: Executing flow creation tests
ansible.builtin.include_tasks:
file: tests/test_flow_creation.yml
- name: Executing unused flow modification tests
ansible.builtin.include_tasks:
file: tests/test_unused_flow_modification.yml
- name: Executing used default browser flow modification tests
ansible.builtin.include_tasks:
file: tests/test_used_default_browser_flow_modification.yml
- name: Executing client flow override flow modification tests
ansible.builtin.include_tasks:
file: tests/test_client_flow_override_flow_modification.yml
- name: Executing identity provider first and post flow override flow modification tests
ansible.builtin.include_tasks:
file: tests/test_identity_provider_flow_overrides_flow_modification.yml
- name: Executing flow deletion tests
ansible.builtin.include_tasks:
file: tests/test_flow_deletion.yml
- name: Invalid providerIds in execution tests
ansible.builtin.include_tasks:
file: tests/test_invalid_providerid_flow_creation.yml
- name: Executing form action flow creation tests
ansible.builtin.include_tasks:
file: tests/test_form_action_flow_creation.yml
- name: Mismatched flow type providerIds in execution tests
ansible.builtin.include_tasks:
file: tests/test_mismatched_flow_type_flow_creation.yml
- name: Executing client flow creation tests
ansible.builtin.include_tasks:
file: tests/test_client_flow_creation.yml
@@ -0,0 +1,164 @@
---
# Ported from community.general tests/integration/targets/keycloak_authz_authorization_scope
# Tests full CRUD lifecycle with check_mode, diff, and idempotency.
- name: Create authorization scope (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
check_mode: true
diff: true
register: result
- name: Assert scope not created in check mode
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == 'Authorization scope would be created'
- result.diff.before == {}
- result.diff.after.name == 'file:delete'
- result.diff.after.displayName == 'File delete'
- result.diff.after.iconUri == 'http://localhost/icon.png'
- name: Create authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == "http://localhost/icon.png"
- result.end_state.displayName == "File delete"
- name: Create authorization scope (idempotency)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == "http://localhost/icon.png"
- result.end_state.displayName == "File delete"
- name: Update scope - remove optional params (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
diff: true
check_mode: true
register: result
- name: Assert scope not updated in check mode
ansible.builtin.assert:
that:
- result is changed
- result.msg == 'Authorization scope would be updated'
- result.diff.before.displayName == 'File delete'
- result.diff.before.iconUri == 'http://localhost/icon.png'
- result.diff.after.displayName == ''
- result.diff.after.iconUri == ''
- name: Update scope - remove optional params
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert optional params removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == ""
- result.end_state.displayName == ""
- name: Update scope - idempotency after removal
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope unchanged after update
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == ""
- result.end_state.displayName == ""
- name: Remove scope (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
diff: true
check_mode: true
register: result
- name: Assert scope not removed in check mode
ansible.builtin.assert:
that:
- result is changed
- result.msg == 'Authorization scope would be removed'
- result.diff.before.name == 'file:delete'
- result.diff.after == {}
- name: Remove scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Remove scope (idempotency)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope already absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,489 @@
---
# Ported from community.general tests/integration/targets/keycloak_authz_permission
# Tests error paths, scope permission CRUD, resource permission CRUD, permission_info queries.
# KC 26.x no longer auto-creates "Default Policy" and "Default Resource"
# when authorization services are enabled via API.
- name: Obtain access token for policy setup
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
body_format: form-urlencoded
body:
grant_type: password
client_id: admin-cli
username: "{{ auth_username }}"
password: "{{ auth_password }}"
validate_certs: false
register: authz_perm_token
- name: Look up client UUID
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients?clientId={{ client }}"
headers:
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
validate_certs: false
register: authz_perm_client
- name: Ensure Default Policy exists (role-based positive policy)
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients/{{ authz_perm_client.json[0].id }}/authz/resource-server/policy/role"
method: POST
headers:
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
Content-Type: application/json
body_format: json
body:
name: "Default Policy"
description: "A default policy"
logic: POSITIVE
roles: []
status_code: [201, 409]
validate_certs: false
- name: Ensure Default Resource exists
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients/{{ authz_perm_client.json[0].id }}/authz/resource-server/resource"
method: POST
headers:
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
Content-Type: application/json
body_format: json
body:
name: "Default Resource"
type: "urn:molecule-client:resources:default"
uris:
- "/*"
status_code: [201, 409]
validate_certs: false
- name: Create file:create authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:create"
display_name: "File create"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
- name: Create file:delete authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
# --- Error paths ---
- name: Create permission without type (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('missing required arguments') == -1
- name: Create scope permission without scopes (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Scopes need to defined when permission type is set to scope!') == -1
- name: Create scope permission with multiple resources (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
resources:
- "Default Resource"
- "Other Resource"
permission_type: scope
scopes:
- "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Only one resource can be defined for a scope permission!') == -1
- name: Create scope permission with invalid policy name (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
scopes:
- "file:delete"
policies:
- "Missing Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Unable to find authorization policy with name') == -1
# --- Scope permission CRUD ---
- name: Create scope permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
scopes:
- "file:delete"
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission"
- result.end_state.type == "scope"
- result.end_state.resources == []
- result.end_state.policies | length == 1
- result.end_state.scopes | length == 1
- name: Query scope permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission"
- name: Create scope permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
scopes:
- "file:delete"
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission unchanged
ansible.builtin.assert:
that:
- result.end_state != {}
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission"
- result.end_state.type == "scope"
- result.end_state.resources == []
- result.end_state.policies | length == 1
- result.end_state.scopes | length == 1
- name: Query scope permission state after idempotency
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches after idempotency
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission"
- name: Update scope permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission changed"
permission_type: scope
decision_strategy: 'AFFIRMATIVE'
scopes:
- "file:create"
- "file:delete"
policies: []
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission updated
ansible.builtin.assert:
that:
- result.changed == True
- result.end_state != {}
- result.end_state.scopes | length == 2
- result.end_state.policies == []
- result.end_state.resources == []
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission changed"
- name: Query updated scope permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches after update
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission changed"
- name: Update scope permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission changed"
permission_type: scope
decision_strategy: 'AFFIRMATIVE'
scopes:
- "file:create"
- "file:delete"
policies: []
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission update idempotent
ansible.builtin.assert:
that:
- result.changed == True
- result.end_state != {}
- result.end_state.scopes | length == 2
- result.end_state.policies == []
- result.end_state.resources == []
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission changed"
- name: Query scope permission state after update idempotency
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches after update idempotency
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission changed"
- name: Remove scope permission
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ScopePermission"
permission_type: scope
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Remove scope permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ScopePermission"
permission_type: scope
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission already absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Resource permission error paths ---
- name: Create resource permission without resources (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
permission_type: resource
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('A resource need to defined when permission type is set to resource!') == -1
- name: Create resource permission with scopes (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
permission_type: resource
resources:
- "Default Resource"
policies:
- "Default Policy"
scopes:
- "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Scopes cannot be defined when permission type is set to resource!') == -1
# --- Resource permission CRUD ---
- name: Create resource permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
resources:
- "Default Resource"
permission_type: resource
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.policies | length == 1
- result.end_state.resources | length == 1
- result.end_state.name == "ResourcePermission"
- result.end_state.description == "Resource permission"
- name: Query resource permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ResourcePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried resource state matches
ansible.builtin.assert:
that:
- result.queried_state.name == "ResourcePermission"
- result.queried_state.description == "Resource permission"
- name: Create resource permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
resources:
- "Default Resource"
permission_type: resource
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission unchanged
ansible.builtin.assert:
that:
- result.end_state != {}
- result.end_state.policies | length == 1
- result.end_state.resources | length == 1
- result.end_state.name == "ResourcePermission"
- result.end_state.description == "Resource permission"
- name: Query resource permission state after idempotency
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ResourcePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried resource state matches after idempotency
ansible.builtin.assert:
that:
- result.queried_state.name == "ResourcePermission"
- result.queried_state.description == "Resource permission"
- name: Update resource permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission changed"
resources:
- "Default Resource"
permission_type: resource
policies: []
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission updated
ansible.builtin.assert:
that:
- result.changed == True
- result.end_state != {}
- result.end_state.policies == []
- result.end_state.resources | length == 1
- result.end_state.name == "ResourcePermission"
- result.end_state.description == "Resource permission changed"
- name: Query updated resource permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ResourcePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried resource state matches after update
ansible.builtin.assert:
that:
- result.queried_state.name == "ResourcePermission"
- result.queried_state.description == "Resource permission changed"
- name: Remove resource permission
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ResourcePermission"
permission_type: resource
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Remove resource permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ResourcePermission"
permission_type: resource
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission already absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,84 @@
---
client_id: myclient
client_id_2: mynewclient
post_logout_redirect_uris:
- "https://example.com/logout-callback"
- "https://example.com/signout"
backchannel_logout_url: "https://example.com/backchannel-logout"
redirect_uris1:
- "http://example.c.com/"
- "http://example.b.com/"
- "http://example.a.com/"
client_attributes1: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "oauth2.device.authorization.grant.enabled": true, "client.secret.creation.time": 0}
client_attributes2: {"backchannel.logout.session.required": false, "oauth2.device.authorization.grant.enabled": false, "client.secret.creation.time": 0}
protocol_mappers1:
- name: 'email'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email"
"user.attribute": "email"
"jsonType.label": "String"
"id.token.claim": true
"access.token.claim": true
"userinfo.token.claim": true
- name: 'email_verified'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email_verified"
"user.attribute": "emailVerified"
"jsonType.label": "boolean"
"id.token.claim": true
"access.token.claim": true
"userinfo.token.claim": true
- name: 'family_name'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "family_name"
"user.attribute": "lastName"
"jsonType.label": "String"
"id.token.claim": "true"
"access.token.claim": "true"
"userinfo.token.claim": "true"
protocol_mappers2_unordered:
- "{{ protocol_mappers1[2] }}"
- "{{ protocol_mappers1[1] }}"
- "{{ protocol_mappers1[0] }}"
protocol_mappers3_modifed:
- "{{ protocol_mappers1[2] }}"
- name: address
protocol: openid-connect
protocolMapper: oidc-address-mapper
consentRequired: false
config:
user.attribute.formatted: formatted
user.attribute.country: country
introspection.token.claim: 'true'
user.attribute.postal_code: postal_code
userinfo.token.claim: 'true'
user.attribute.street: street
id.token.claim: 'true'
user.attribute.region: region
access.token.claim: 'true'
user.attribute.locality: locality
- name: 'email'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email"
"user.attribute": "email"
"jsonType.label": "String"
"id.token.claim": true
"access.token.claim": false
"userinfo.token.claim": true
@@ -0,0 +1,409 @@
---
# Ported from community.general tests/integration/targets/keycloak_client
# Tests protocol_mapper CRUD, flow binding overrides, client_scopes_behavior,
# attribute updates, and post-logout redirect URIs / backchannel logout URL.
- name: Load client test variables
ansible.builtin.include_vars:
file: vars.yml
# --- Protocol mapper create, idempotency, and modification ---
- name: Desire client
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
register: desire_client_not_present
- name: Desire client again with same props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
register: desire_client_when_present_and_same
- name: Check client again with same props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers2_unordered }}"
authorization_services_enabled: false
check_mode: true
register: check_client_when_present_and_same
- name: Assert changes not detected in last two tasks (desire when same, and check)
ansible.builtin.assert:
that:
- desire_client_when_present_and_same is not changed
- check_client_when_present_and_same is not changed
- name: Check client again with changed props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authorization_services_enabled: false
service_accounts_enabled: false
check_mode: true
register: check_client_when_present_and_changed
- name: Assert changes detected in last tasks
ansible.builtin.assert:
that:
- check_client_when_present_and_changed is changed
- name: Check client with modified protocol_mappers idempotence
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers3_modifed }}"
authorization_services_enabled: false
service_accounts_enabled: true
register: check_client_protocol_mappers_idempotence
- name: Assert idempotence changes to protocol_mappers
ansible.builtin.assert:
that:
- check_client_protocol_mappers_idempotence is changed
- end_state.protocolMappers | length == 3
- end_state.protocolMappers | selectattr('name', 'equalto', 'email_verified') | list | length == 0
- end_state.protocolMappers | selectattr('name', 'equalto', 'address') | list | length == 1
- end_state.protocolMappers | selectattr('name', 'equalto', 'email') | list | length == 1
- end_state.protocolMappers | selectattr('name', 'equalto', 'family_name') | list | length == 1
- email.config is defined
- email.config['access.token.claim'] == "false"
vars:
end_state: "{{ check_client_protocol_mappers_idempotence.end_state }}"
email: "{{ end_state.protocolMappers | selectattr('name', 'equalto', 'email') | first | default({}) }}"
# --- Flow binding overrides ---
- name: Desire client with flow binding overrides
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser_name: browser
direct_grant_name: direct grant
register: desire_client_with_flow_binding_overrides
- name: Assert flows are set
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser | length > 0
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant | length > 0
- name: Backup flow UUIDs
ansible.builtin.set_fact:
flow_browser_uuid: "{{ desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser }}"
flow_direct_grant_uuid: "{{ desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant }}"
- name: Desire client with flow binding overrides remove direct_grant_name
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser_name: browser
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser | length > 0
- "'direct_grant' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- name: Desire client with flow binding overrides remove browser add direct_grant
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
direct_grant_name: direct grant
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- "'browser' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant | length > 0
- name: Desire client with flow binding overrides with UUIDs
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser: "{{ flow_browser_uuid }}"
direct_grant: "{{ flow_direct_grant_uuid }}"
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser == flow_browser_uuid
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant == flow_direct_grant_uuid
- name: Unset flow binding overrides
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser: "{{ None }}"
direct_grant: null
register: desire_client_with_flow_binding_overrides
- name: Assert flows are removed
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- "'browser' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- "'direct_grant' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
# --- Client scopes behavior ---
- name: Create a scope1 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope1
description: "test 1"
protocol: openid-connect
- name: Create a scope2 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope2
description: "test 2"
protocol: openid-connect
- name: Create a scope3 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope3
description: "test 3"
protocol: openid-connect
- name: Create Keycloak client with default_client_scopes (idempotent behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: idempotent
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert default_client_scopes and optional_client_scopes are set correctly
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- '"scope1" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
- end_state.defaultClientScopes | length == 1
- end_state.optionalClientScopes | length == 1
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with new scopes (ignore behavior, check mode)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope3']
optional_client_scopes: ['scope3']
client_id: testSD-bug
state: present
check_mode: true
register: desire_client_with_default_client_scopes
- name: Assert client scopes remain unchanged with ignore behavior
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is not changed
- end_state.defaultClientScopes | length == 1
- end_state.optionalClientScopes | length == 1
- '"scope1" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with conflicting scopes (patch behavior, should fail)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: patch
default_client_scopes: ['scope3']
optional_client_scopes: ['scope1', 'scope2', 'scope3']
client_id: testSD-bug
state: present
ignore_errors: true
register: desire_client_with_default_client_scopes
- name: Assert patch behavior fails when scope is both default and optional
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is failed
- "'scope3' in desire_client_with_default_client_scopes.msg"
- name: Update Keycloak client with new scopes (patch behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: patch
default_client_scopes: ['scope1', 'scope3']
optional_client_scopes: []
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert client scopes are patched correctly
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- end_state.defaultClientScopes | length == 2
- end_state.optionalClientScopes | length == 1
- '"scope1" in end_state.defaultClientScopes'
- '"scope3" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with empty default_client_scopes (idempotent behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: idempotent
default_client_scopes: []
optional_client_scopes: ['scope3']
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert idempotent behavior with empty default_client_scopes
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- end_state.defaultClientScopes | length == 0
- end_state.optionalClientScopes | length == 1
- '"scope3" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
# --- Attribute updates ---
- name: Create client with initial attributes
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
state: present
attributes: "{{ client_attributes1 }}"
register: check_client_when_present_and_attributes_modified
- name: Update client attributes
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
state: present
attributes: "{{ client_attributes2 }}"
register: check_client_when_present_and_attributes_modified
- name: Assert client attributes are updated
ansible.builtin.assert:
that:
- check_client_when_present_and_attributes_modified is changed
- end_state.attributes["backchannel.logout.revoke.offline.tokens"] == 'false'
- end_state.attributes["backchannel.logout.session.required"] == 'false'
- end_state.attributes["oauth2.device.authorization.grant.enabled"] == 'false'
vars:
end_state: "{{ check_client_when_present_and_attributes_modified.end_state }}"
# --- Post-logout redirect URIs and backchannel logout URL ---
- name: Create client with post logout redirect URIs and backchannel logout URL
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris: "{{ post_logout_redirect_uris }}"
backchannel_logout_url: "{{ backchannel_logout_url }}"
state: present
register: result_create_logout_client
- name: Assert logout client is created with correct attributes
ansible.builtin.assert:
that:
- result_create_logout_client is changed
- result_create_logout_client.end_state.attributes["post.logout.redirect.uris"] is defined
- result_create_logout_client.end_state.attributes["backchannel.logout.url"] == backchannel_logout_url
- name: Re-create client with same logout fields (idempotency)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris: "{{ post_logout_redirect_uris }}"
backchannel_logout_url: "{{ backchannel_logout_url }}"
state: present
register: result_idempotent_logout_client
- name: Assert logout client is idempotent
ansible.builtin.assert:
that:
- result_idempotent_logout_client is not changed
- name: Update client logout fields
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris:
- "https://example.com/new-logout"
backchannel_logout_url: "https://example.com/new-backchannel"
state: present
register: result_update_logout_client
- name: Assert logout client fields are updated
ansible.builtin.assert:
that:
- result_update_logout_client is changed
- result_update_logout_client.end_state.attributes["backchannel.logout.url"] == "https://example.com/new-backchannel"
- name: Delete logout test client
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
state: absent
@@ -0,0 +1,242 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_rolescope
# Tests multi-role mapping, remap idempotency, partial removal, error handling,
# duplicate roles, realm role operations, full-scope client rejection, and check_mode.
# --- Fixtures ---
- name: Create realm roles for rolescope test
middleware_automation.keycloak.keycloak_role:
name: "{{ item }}"
realm: "{{ ephemeral_realm }}"
state: present
loop:
- realm-role-admin
- realm-role-user
- name: Create private client (full_scope_allowed)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: backend-client-private
state: present
redirect_uris:
- "https://my-backend-api.c.org/"
full_scope_allowed: true
attributes: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "client.secret.creation.time": 0}
public_client: false
- name: Create client roles on private client
middleware_automation.keycloak.keycloak_role:
name: "{{ item }}"
realm: "{{ ephemeral_realm }}"
client_id: backend-client-private
state: present
loop:
- client-role-admin
- client-role-user
- name: Create public client (full_scope_allowed false)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: frontend-client-public
redirect_uris:
- "https://my-onepage-app-frontend.c.org/"
attributes: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "client.secret.creation.time": 0}
full_scope_allowed: false
public_client: true
# --- Client role scope mapping ---
- name: Map two client roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-user
register: result
- name: Assert both client roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Remap single role (additive idempotency)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-user
register: result
- name: Assert no change - both still mapped
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 2
- name: Remove admin role from public client scope
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
state: absent
register: result
- name: Assert admin removed, user remains
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- result.end_state[0].name == "client-role-user"
# --- Error: missing role ---
- name: Map non-existent client role (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-missing
ignore_errors: true
register: result
- name: Assert failure on missing client role
ansible.builtin.assert:
that:
- result is failed
# --- Duplicate role names ---
- name: Map duplicate role names
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-admin
register: result
- name: Assert duplicate handled - both roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
# --- Error: full-scope client ---
- name: Map realm role to full-scope private client (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: backend-client-private
role_names:
- realm-role-admin
ignore_errors: true
register: result
- name: Assert failure on full-scope client
ansible.builtin.assert:
that:
- result is failed
# --- Realm role scope mapping ---
- name: Map one realm role to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
register: result
- name: Assert realm role mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- name: Map two realm roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
register: result
- name: Assert both realm roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Unmap all realm roles from public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
state: absent
register: result
- name: Assert all realm roles unmapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 0
# --- Error: missing realm role ---
- name: Map non-existent realm role (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- client-role-missing
ignore_errors: true
register: result
- name: Assert failure on missing realm role
ansible.builtin.assert:
that:
- result is failed
# --- Check mode ---
- name: Check-mode map realm roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
check_mode: true
register: result
- name: Assert check-mode reports changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Verify check-mode did not actually apply changes
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names: []
register: result
- name: Assert no roles present after check-mode
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 0
@@ -0,0 +1,247 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_scope_rolemappings
# Tests multi-role mapping, error paths, check_mode, partial removal, and full-scope rejection.
# --- Fixtures ---
- name: Create client for scope rolemapping tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
state: present
public_client: true
full_scope_allowed: false
- name: Create full-scope client for rejection test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: full-scope-client
state: present
public_client: true
full_scope_allowed: true
- name: Create realm roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ item }}"
loop:
- realm-role-admin
- realm-role-user
- name: Create client roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
name: "{{ item }}"
loop:
- client-role-admin
- client-role-user
- name: Create client roles in full-scope client
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: full-scope-client
name: "{{ item }}"
loop:
- client-role-admin
- client-role-user
- name: Create client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: client-scope
description: ""
protocol: openid-connect
state: present
# --- Client role mapping tests ---
- name: Map two client roles to scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-user
register: result
- name: Assert both client roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Remap one existing client role (idempotency - additive)
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-user
register: result
- name: Assert no change and both still mapped
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 2
- name: Remove admin client role from scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
state: absent
register: result
- name: Assert admin role removed and user role remains
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- result.end_state[0].name == "client-role-user"
- name: Map non-existent client role
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-missing
ignore_errors: true
register: result
- name: Assert failed for missing client role
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"Failed to retrieve role '\" ~ ephemeral_realm ~ \".backend-client.client-role-missing'\""
- name: Map duplicate client roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-admin
register: result
- name: Assert duplicate handled and both roles present
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Map role to full-scope client (should fail)
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
client_id: full-scope-client
role_names:
- client-role-admin
ignore_errors: true
register: result
- name: Assert full-scope client rejected
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"FullScopeAllowed is active for Client '\" ~ ephemeral_realm ~ \".full-scope-client'\""
# --- Realm role mapping tests ---
- name: Map one realm role to scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
register: result
- name: Assert realm role mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- name: Map two realm roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
register: result
- name: Assert both realm roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Unmap all realm roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
state: absent
register: result
- name: Assert all realm roles unmapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 0
- name: Map non-existent realm role
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- client-role-missing
ignore_errors: true
register: result
- name: Assert failed for missing realm role
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"Failed to retrieve role '\" ~ ephemeral_realm ~ \".client-role-missing'\""
# --- Check-mode test ---
- name: Map realm roles in check mode
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
check_mode: true
register: result
- name: Assert check mode reports change
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Verify check mode did not persist changes
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names: []
register: result
- name: Assert no roles actually mapped after check mode
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 0
@@ -0,0 +1,115 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_scope_type
# Tests full realm-level and client-level scope type management with idempotency.
- name: Create client for scope type tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
state: present
enabled: true
- name: Create scope1 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope1
description: "test 1"
protocol: openid-connect
- name: Create scope2 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope2
description: "test 2"
protocol: openid-connect
# --- Realm level ---
- name: Set both scopes as realm defaults
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
- name: Assert realm default scopes are set
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.default_client_scopes'
- result.end_state.default_client_scopes | length == 2
- result.end_state.optional_client_scopes | length == 0
- name: Set same realm defaults (idempotency)
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
failed_when: result is changed
- name: Move scope2 to optional at realm level
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
register: result
- name: Assert scope2 moved to optional
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.optional_client_scopes'
- result.end_state.default_client_scopes | length == 1
- result.end_state.optional_client_scopes | length == 1
# --- Client level ---
- name: Set both scopes as client defaults
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
- name: Assert client default scopes are set
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.default_client_scopes'
- result.end_state.default_client_scopes | length == 2
- result.end_state.optional_client_scopes | length == 0
- name: Set same client defaults (idempotency)
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
failed_when: result is changed
- name: Move scope2 to optional at client level
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
register: result
- name: Assert scope2 moved to optional on client
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.optional_client_scopes'
- result.end_state.default_client_scopes | length == 1
- result.end_state.optional_client_scopes | length == 1
@@ -0,0 +1,33 @@
---
# Ported from community.general tests/integration/targets/keycloak_clientsecret_info
# Tests fetch-by-client_id vs fetch-by-id and value assertions.
- name: Look up test client to get internal id
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
state: present
register: client_lookup
- name: Fetch client secret by client_id
middleware_automation.keycloak.keycloak_clientsecret_info:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
register: fetch_by_client_id_result
- name: Assert client secret retrieved by client_id
ansible.builtin.assert:
that:
- fetch_by_client_id_result.clientsecret_info.type == "secret"
- fetch_by_client_id_result.clientsecret_info.value | length >= 32
- name: Fetch client secret by internal id
middleware_automation.keycloak.keycloak_clientsecret_info:
realm: "{{ target_realm }}"
id: "{{ client_lookup.end_state.id }}"
register: fetch_by_id_result
- name: Assert both fetch methods return the same secret value
ansible.builtin.assert:
that:
- fetch_by_id_result.clientsecret_info.value == fetch_by_client_id_result.clientsecret_info.value
@@ -0,0 +1,34 @@
---
# Ported from community.general tests/integration/targets/keycloak_clientsecret_regenerate
# Tests regenerate-by-client_id vs regenerate-by-id and rotation contract.
- name: Look up test client to get internal id
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
state: present
register: client_lookup
- name: Regenerate client secret by client_id
middleware_automation.keycloak.keycloak_clientsecret_regenerate:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
register: regenerate_by_client_id
- name: Assert regenerated secret is valid
ansible.builtin.assert:
that:
- regenerate_by_client_id.end_state.type == "secret"
- regenerate_by_client_id.end_state.value | length >= 32
- name: Regenerate client secret by internal id
middleware_automation.keycloak.keycloak_clientsecret_regenerate:
realm: "{{ target_realm }}"
id: "{{ client_lookup.end_state.id }}"
register: regenerate_by_id
- name: Assert secret value changed after second regeneration
ansible.builtin.assert:
that:
- regenerate_by_id.end_state.value | length >= 32
- regenerate_by_id.end_state.value != regenerate_by_client_id.end_state.value
@@ -0,0 +1,218 @@
---
# Ported from community.general tests/integration/targets/keycloak_component_info
# Tests querying components by name, provider_type, parent_id, and combined filters.
- name: Query LDAP federation when absent
middleware_automation.keycloak.keycloak_component_info:
name: myldap
provider_type: "org.keycloak.storage.UserStorageProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert LDAP federation is absent
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 0
- name: Create LDAP federation for component_info tests
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: myldap
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldap://ldap.example.com"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
mappers:
- name: "email"
providerId: "user-attribute-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.attribute: mail
user.model.attribute: email
is.mandatory.in.ldap: "false"
read.only: "true"
- name: "username"
providerId: "user-attribute-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.attribute: uid
user.model.attribute: username
is.mandatory.in.ldap: "true"
read.only: "true"
state: present
- name: Query LDAP federation by name and type
middleware_automation.keycloak.keycloak_component_info:
name: myldap
provider_type: "org.keycloak.storage.UserStorageProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert LDAP federation found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].name == "myldap"
- name: Save LDAP federation id
ansible.builtin.set_fact:
ci_ldap_id: "{{ result.components[0].id }}"
- name: Query LDAP subcomponents by parent_id
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
register: result
- name: Assert subcomponents exist
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- name: Query LDAP subcomponents filter by name
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
name: "email"
register: result
- name: Assert subcomponent with name email exists
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].name == "email"
- name: Query LDAP subcomponents filter by type
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
register: result
- name: Assert LDAP mapper subcomponents found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- result.components[0].providerType == "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
- name: Query key info when absent
middleware_automation.keycloak.keycloak_component_info:
name: testkey
provider_type: "org.keycloak.keys.KeyProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert key is missing
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 0
- name: Create AES realm key for component query test
middleware_automation.keycloak.keycloak_realm_key:
name: testkey
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
priority: 150
enabled: true
active: true
- name: Query key component by name and type
middleware_automation.keycloak.keycloak_component_info:
name: testkey
provider_type: "org.keycloak.keys.KeyProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert key component found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- name: Query all realm components
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert realm has components
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- name: Query all UserStorageProviders in realm
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
provider_type: "org.keycloak.storage.UserStorageProvider"
register: result
- name: Assert only the LDAP federation is returned
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].providerType == "org.keycloak.storage.UserStorageProvider"
- result.components[0].name == "myldap"
- name: Query component by name only
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
name: testkey
register: result
- name: Assert key found by name only
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].providerType == "org.keycloak.keys.KeyProvider"
- result.components[0].name == "testkey"
- name: Clean up - remove AES key
middleware_automation.keycloak.keycloak_realm_key:
name: testkey
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
state: absent
- name: Clean up - remove LDAP federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: myldap
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
state: absent
@@ -0,0 +1,412 @@
---
# Ported from community.general tests/integration/targets/keycloak_group
# Tests group CRUD, custom attributes, subgroups, deep chains, and deletion patterns.
# --- Group CRUD ---
- name: Create a group
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: test-group
state: present
register: result
- name: Assert group was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "test-group"
- result.end_state.path == "/test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Save group id
ansible.builtin.set_fact:
molecule_grp_test_id: "{{ result.end_state.id }}"
- name: Create group again (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: test-group
state: present
register: result
- name: Assert group unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "test-group"
- result.end_state.path == "/test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Rename group by id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
name: new-test-group
state: present
register: result
- name: Assert group was renamed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "new-test-group"
- result.end_state.path == "/new-test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Delete group by id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
state: absent
register: result
- name: Assert group was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete group by id again (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
state: absent
register: result
- name: Assert no change on absent group
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Custom attributes ---
- name: Create group with custom attributes
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: my-new_group
attributes:
attrib1: value1
attrib2: value2
attrib3:
- item1
- item2
register: result
- name: Assert group created with attributes
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "my-new_group"
- result.end_state.path == "/my-new_group"
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- result.end_state.attributes != {}
- result.end_state.attributes.attrib1 == ["value1"]
- result.end_state.attributes.attrib2 == ["value2"]
- result.end_state.attributes.attrib3 == ["item1", "item2"]
- name: Delete group with attributes by name
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: my-new_group
state: absent
register: result
- name: Assert group with attributes was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
# --- Subgroup tests ---
- name: Create base group for subgroup testing
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
register: grp_root_result
- name: Create subgroup using parent id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup created by parent id
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subgrp1"
- result.end_state.path == "/rootgrp/subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate subgroup using parent id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "subgrp1"
- result.end_state.path == "/rootgrp/subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Rename subgroup
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result.end_state.id }}"
name: new-subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup renamed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "new-subgrp1"
- result.end_state.path == "/rootgrp/new-subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Create subgroup using parent name
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp2
parents:
- name: rootgrp
register: result
- name: Assert subgroup created by parent name
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subgrp2"
- result.end_state.path == "/rootgrp/subgrp2"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate subgroup using parent name (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp2
parents:
- name: rootgrp
register: result
- name: Assert subgroup unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "subgrp2"
- result.end_state.path == "/rootgrp/subgrp2"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
# --- Sub-subgroup (deep chain) ---
- name: Create sub-subgroup using parent name chain
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubgrp
parents:
- name: rootgrp
- name: subgrp2
register: result
- name: Assert sub-subgroup created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subsubgrp"
- result.end_state.path == "/rootgrp/subgrp2/subsubgrp"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate sub-subgroup using parent names (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubgrp
parents:
- name: rootgrp
- name: subgrp2
register: result_subsub
- name: Assert sub-subgroup unchanged
ansible.builtin.assert:
that:
- result_subsub is not changed
- result_subsub.end_state != {}
- result_subsub.end_state.name == "subsubgrp"
- result_subsub.end_state.path == "/rootgrp/subgrp2/subsubgrp"
- result_subsub.end_state.attributes == {}
- result_subsub.end_state.clientRoles == {}
- result_subsub.end_state.realmRoles == []
- result_subsub.end_state.subGroups == []
- name: Create sub-sub-subgroup using direct parent id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubsubgrp
parents:
- id: "{{ result_subsub.end_state.id }}"
register: result
- name: Assert sub-sub-subgroup created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subsubsubgrp"
- result.end_state.path == "/rootgrp/subgrp2/subsubgrp/subsubsubgrp"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate sub-sub-subgroup using direct parent id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubsubgrp
parents:
- id: "{{ result_subsub.end_state.id }}"
register: result_subsubsub
- name: Assert sub-sub-subgroup unchanged
ansible.builtin.assert:
that:
- result_subsubsub is not changed
- result_subsubsub.end_state != {}
- result_subsubsub.end_state.name == "subsubsubgrp"
- result_subsubsub.end_state.path == "/rootgrp/subgrp2/subsubgrp/subsubsubgrp"
- result_subsubsub.end_state.attributes == {}
- result_subsubsub.end_state.clientRoles == {}
- result_subsubsub.end_state.realmRoles == []
- result_subsubsub.end_state.subGroups == []
# --- Subgroup deletion ---
- name: Delete subgroup by id (no parents needed)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result_subsubsub.end_state.id }}"
state: absent
register: result
- name: Assert subgroup deleted by id
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo subgroup deletion by id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result_subsubsub.end_state.id }}"
state: absent
register: result
- name: Assert subgroup deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Delete subgroup by name with parents
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: new-subgrp1
parents:
- name: rootgrp
state: absent
register: result
- name: Assert subgroup deleted by name
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo subgroup deletion by name (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: new-subgrp1
parents:
- name: rootgrp
state: absent
register: result
- name: Assert subgroup name deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Delete group that has subgroups (cascade)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
state: absent
register: result
- name: Assert group with subgroups deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo delete group with subgroups (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
state: absent
register: result
- name: Assert group deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,4 @@
---
role_1: myrole-1
role_2: myrole-2
test_group: mygroup
@@ -0,0 +1,113 @@
---
# Ported from community.general tests/integration/targets/keycloak_group_rolemapping
# Tests full map/unmap lifecycle with idempotency for realm role mappings on groups.
- name: Load group rolemapping test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create realm roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ item }}"
state: present
loop:
- "{{ role_1 }}"
- "{{ role_2 }}"
- name: Create group
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ test_group }}"
state: present
- name: Map realm roles to group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
- name: "{{ role_2 }}"
state: present
register: result
- name: Assert realm roles are assigned to group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 2
- name: Map realm roles to group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
- name: "{{ role_2 }}"
state: present
register: result
- name: Assert realm roles stay assigned to group
ansible.builtin.assert:
that:
- result is not changed
- name: Unmap realm role 1 from group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
state: absent
register: result
- name: Assert realm role 1 is unassigned from group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 1
- result.end_state[0] == role_2
- name: Unmap realm role 1 from group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
state: absent
register: result
- name: Assert realm role 1 stays unassigned from group
ansible.builtin.assert:
that:
- result is not changed
- name: Unmap realm role 2 from group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_2 }}"
state: absent
register: result
- name: Assert no realm roles are assigned to group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 0
- name: Unmap realm role 2 from group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_2 }}"
state: absent
register: result
- name: Assert no realm roles are assigned to group
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | count == 0
@@ -0,0 +1,264 @@
---
# Ported from community.general tests/integration/targets/keycloak_identity_provider
# Tests create with mappers, mapper CRUD, update, clientSecret masking, delete idempotency, fromUrl discovery.
- name: Create new identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
display_name: OpenID Connect IdP
enabled: true
provider_id: oidc
config:
issuer: https://idp.example.com
authorizationUrl: https://idp.example.com/auth
tokenUrl: https://idp.example.com/token
userInfoUrl: https://idp.example.com/userinfo
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
syncMode: FORCE
mappers:
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
state: present
register: result
- name: Assert identity provider created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.alias == "myidp"
- result.end_state.mappers != []
- result.end_state.config.clientSecret == "**********"
- name: Update existing identity provider (no change)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
enabled: true
provider_id: oidc
config:
issuer: https://idp.example.com
authorizationUrl: https://idp.example.com/auth
tokenUrl: https://idp.example.com/token
userInfoUrl: https://idp.example.com/userinfo
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: "**********"
syncMode: FORCE
mappers:
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
state: present
register: result
- name: Assert identity provider unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update existing identity provider (with change, no mapper change)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
enabled: false
state: present
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.enabled == true
- result.end_state.enabled == false
- name: Update existing identity provider (delete mapper)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.mappers | length == 2
- result.end_state.mappers | length == 1
- result.end_state.mappers[0].name == "first_name"
- name: Update existing identity provider (add mapper)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.mappers | length == 1
- result.end_state.mappers | length == 2
- name: Update existing identity provider (no change, test mapper idempotency)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is not changed
- name: Delete existing identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: absent
register: result
- name: Assert identity provider deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: absent
register: result
- name: Assert identity provider unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Create IDP realm
middleware_automation.keycloak.keycloak_realm:
id: myidprealm
realm: myidprealm
state: present
- name: Create new identity provider with fromUrl
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidpfromurl
display_name: OpenID Connect IdP from url
enabled: true
provider_id: oidc
config:
fromUrl: "{{ auth_keycloak_url }}/realms/myidprealm/.well-known/openid-configuration"
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
syncMode: FORCE
state: present
register: result
- name: Assert identity provider created with IDP endpoints
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.authorizationUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/auth"
- result.end_state.config.issuer == auth_keycloak_url ~ "/realms/myidprealm"
- result.end_state.config.jwksUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/certs"
- result.end_state.config.logoutUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/logout"
- result.end_state.config.tokenUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/token"
- result.end_state.config.userInfoUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/userinfo"
- name: Create new identity provider with fromUrl and exclusion should fail
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: "mustfail"
display_name: Failed OpenID Connect IdP from url
enabled: true
provider_id: oidc
config: "{{ config | combine(endpoint) }}"
state: present
vars:
config:
fromUrl: "{{ auth_keycloak_url }}/realms/myidprealm/.well-known/openid-configuration"
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
endpoint: "{{ { item: auth_keycloak_url ~ '/realms/myidprealm/protocol/openid-connect/' ~ item } }}"
with_items: ['userInfoUrl', 'authorizationUrl', 'tokenUrl', 'logoutUrl', 'issuer', 'jwksUrl']
register: result
ignore_errors: true
- name: Check failure of identity provider creation with fromUrl and userInfoUrl
ansible.builtin.assert:
that:
- result is not changed
- result is failed
- result.results | selectattr('failed', 'equalto', false) | list | length == 0
@@ -0,0 +1,4 @@
---
client_secret: myclientsecret
auth_test_role: myrole
keycloak_role_description: test
@@ -0,0 +1,281 @@
---
# Ported from community.general tests/integration/targets/keycloak_modules_authentication
# Tests the authentication layer shared by all keycloak modules:
# token auth, refresh token fallback, auth fallback chains, client_credentials, and 401 errors.
- name: Load authentication test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Reset public login in master admin-cli (if potentially previous test failed)
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: true
state: present
- name: Create new realm role with username/password authentication
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert username/password authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Get Keycloak token
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/master/protocol/openid-connect/token"
method: POST
return_content: true
status_code: 200
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
- name: Extract tokens
ansible.builtin.set_fact:
access_token: "{{ token_response.json.access_token }}"
refresh_token: "{{ token_response.json.refresh_token }}"
- name: Create new realm role with provided token authentication
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
token: "{{ access_token }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert token authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token and valid refresh token
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
refresh_token: "{{ refresh_token }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert refresh token fallback authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token and valid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert username/password fallback authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token, invalid refresh token, and valid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
refresh_token: "invalidrefreshtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert full fallback chain authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Test client_credentials authentication
block:
- name: PREPARE - Temporarily disable public login in master admin-cli
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: false
service_accounts_enabled: true
client_authenticator_type: client-secret
state: present
- name: PREPARE - Assign admin role to admin-cli in master
middleware_automation.keycloak.keycloak_user_rolemapping:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
realm: master
roles:
- name: admin
service_account_user_client_id: admin-cli
- name: Create new realm role with valid client_id and client_secret
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert client_credentials authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
always:
- name: Reset temporarily disabled public login in master admin-cli
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: true
state: present
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
### Unhappy path tests
- name: Fail to create new realm role with invalid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "invalid_password"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
- name: Fail to create new realm role with invalid auth token
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_username: ""
auth_password: ""
token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
- name: Fail to create new realm role with invalid auth and refresh tokens, and invalid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "invalid_password"
token: "invalidtoken!!!"
refresh_token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
@@ -0,0 +1,56 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm
# Tests session timeout and OAuth2 device settings on keycloak_realm module.
- name: Modify realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
client_session_idle_timeout: 240
client_session_max_lifespan: 21600
client_offline_session_idle_timeout: 100
client_offline_session_max_lifespan: 200
oauth2_device_code_lifespan: 700
oauth2_device_polling_interval: 800
state: present
register: result
- name: Assert result
ansible.builtin.assert:
that:
- result is changed
- result.end_state.clientSessionIdleTimeout == 240
- result.end_state.clientSessionMaxLifespan == 21600
- result.end_state.clientOfflineSessionIdleTimeout == 100
- result.end_state.clientOfflineSessionMaxLifespan == 200
- result.end_state.oauth2DeviceCodeLifespan == 700
- result.end_state.oauth2DevicePollingInterval == 800
- name: Delete realm
middleware_automation.keycloak.keycloak_realm:
realm: "{{ ephemeral_realm }}"
state: absent
- name: create realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
client_session_idle_timeout: 240
client_session_max_lifespan: 21600
client_offline_session_idle_timeout: 100
client_offline_session_max_lifespan: 200
oauth2_device_code_lifespan: 700
oauth2_device_polling_interval: 800
state: present
register: result
- name: Assert result
ansible.builtin.assert:
that:
- result is changed
- result.end_state.clientSessionIdleTimeout == 240
- result.end_state.clientSessionMaxLifespan == 21600
- result.end_state.clientOfflineSessionIdleTimeout == 100
- result.end_state.clientOfflineSessionMaxLifespan == 200
- result.end_state.oauth2DeviceCodeLifespan == 700
- result.end_state.oauth2DevicePollingInterval == 800
@@ -0,0 +1,526 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm_key
# Tests auto-generated key providers: HMAC, AES, ECDSA, RSA, RSA-ENC, ECDH, EdDSA.
# Skips RSA with private key (needs external key material) and Java Keystore (needs keystore file).
# --- HMAC generated key ---
- name: Create HMAC key (check mode)
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
check_mode: true
register: result
- name: Assert HMAC key would be created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "hmac-test-key"
- result.end_state.providerId == "hmac-generated"
- result.end_state.config.algorithm == ["HS256"]
- result.end_state.config.secretSize == ["64"]
- result.msg == "Realm key hmac-test-key would be created"
- name: Create HMAC key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "hmac-test-key"
- result.end_state.providerId == "hmac-generated"
- result.end_state.providerType == "org.keycloak.keys.KeyProvider"
- result.end_state.config.algorithm == ["HS256"]
- result.end_state.config.secretSize == ["64"]
- result.msg == "Realm key hmac-test-key created"
- name: Create HMAC key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key hmac-test-key was in sync"
- name: Update HMAC key priority
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 110
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key was updated
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.priority == ["110"]
- "'config.priority' in result.msg"
- name: Remove HMAC key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
priority: 110
register: result
- name: Assert HMAC key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Realm key hmac-test-key deleted"
# --- AES generated key ---
- name: Create AES key
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
enabled: true
active: true
priority: 100
secret_size: 32
register: result
- name: Assert AES key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "aes-test-key"
- result.end_state.providerId == "aes-generated"
- result.end_state.config.secretSize == ["32"]
- result.msg == "Realm key aes-test-key created"
- name: Create AES key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
enabled: true
active: true
priority: 100
secret_size: 32
register: result
- name: Assert AES key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key aes-test-key was in sync"
- name: Remove AES key
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
priority: 100
register: result
- name: Assert AES key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key aes-test-key deleted"
# --- ECDSA generated key ---
- name: Create ECDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: ES256
elliptic_curve: P-256
register: result
- name: Assert ECDSA key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ecdsa-test-key"
- result.end_state.providerId == "ecdsa-generated"
- result.end_state.config.algorithm == ["ES256"]
- result.end_state.config.ecdsaEllipticCurveKey == ["P-256"]
- result.msg == "Realm key ecdsa-test-key created"
- name: Create ECDSA key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: ES256
elliptic_curve: P-256
register: result
- name: Assert ECDSA key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key ecdsa-test-key was in sync"
- name: Remove ECDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
priority: 100
register: result
- name: Assert ECDSA key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key ecdsa-test-key deleted"
# --- RSA generated key ---
- name: Create RSA generated key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: RS256
key_size: 2048
register: result
- name: Assert RSA generated key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "rsa-gen-test-key"
- result.end_state.providerId == "rsa-generated"
- result.end_state.config.algorithm == ["RS256"]
- result.end_state.config.keySize == ["2048"]
- result.msg == "Realm key rsa-gen-test-key created"
- name: Create RSA generated key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: RS256
key_size: 2048
register: result
- name: Assert RSA generated key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key rsa-gen-test-key was in sync"
- name: Remove RSA generated key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
priority: 100
register: result
- name: Assert RSA generated key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key rsa-gen-test-key deleted"
# --- Default realm key management ---
- name: Update priority of default hmac-generated key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-generated
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 150
algorithm: HS256
register: result
- name: Assert default hmac-generated key was updated
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.priority == ["150"]
- name: Remove default hmac-generated key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-generated
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
priority: 150
register: result
- name: Assert default hmac-generated key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Realm key hmac-generated deleted"
# --- RSA encryption generated key ---
- name: Create RSA encryption key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
enabled: true
active: true
priority: 100
algorithm: RSA-OAEP
key_size: 2048
register: result
- name: Assert RSA encryption key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "rsa-enc-gen-test-key"
- result.end_state.providerId == "rsa-enc-generated"
- result.end_state.config.algorithm == ["RSA-OAEP"]
- result.end_state.config.keySize == ["2048"]
- result.msg == "Realm key rsa-enc-gen-test-key created"
- name: Create RSA encryption key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
enabled: true
active: true
priority: 100
algorithm: RSA-OAEP
key_size: 2048
register: result
- name: Assert RSA encryption key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key rsa-enc-gen-test-key was in sync"
- name: Remove RSA encryption key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
priority: 100
register: result
- name: Assert RSA encryption key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key rsa-enc-gen-test-key deleted"
# --- ECDH generated key ---
- name: Create ECDH key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
enabled: true
active: true
priority: 100
algorithm: ECDH_ES
elliptic_curve: P-256
register: result
- name: Assert ECDH key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ecdh-test-key"
- result.end_state.providerId == "ecdh-generated"
- result.end_state.config.algorithm == ["ECDH_ES"]
- result.end_state.config.ecdhEllipticCurveKey == ["P-256"]
- result.msg == "Realm key ecdh-test-key created"
- name: Create ECDH key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
enabled: true
active: true
priority: 100
algorithm: ECDH_ES
elliptic_curve: P-256
register: result
- name: Assert ECDH key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key ecdh-test-key was in sync"
- name: Remove ECDH key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
priority: 100
register: result
- name: Assert ECDH key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key ecdh-test-key deleted"
# --- EdDSA generated key ---
- name: Create EdDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
enabled: true
active: true
priority: 100
elliptic_curve: Ed25519
register: result
- name: Assert EdDSA key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "eddsa-test-key"
- result.end_state.providerId == "eddsa-generated"
- result.end_state.config.eddsaEllipticCurveKey == ["Ed25519"]
- result.msg == "Realm key eddsa-test-key created"
- name: Create EdDSA key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
enabled: true
active: true
priority: 100
elliptic_curve: Ed25519
register: result
- name: Assert EdDSA key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key eddsa-test-key was in sync"
- name: Remove EdDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
priority: 100
register: result
- name: Assert EdDSA key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key eddsa-test-key deleted"
@@ -0,0 +1,6 @@
---
keycloak_username: test
keycloak_user_groups:
- name: test
state: present
- name: test2
@@ -0,0 +1,57 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm_users_info
# Tests multi-user listing and group membership in realm users info response.
- name: Load realm users info test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new groups
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ item.name }}"
state: present
loop: "{{ keycloak_user_groups }}"
- name: Create user
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
state: present
register: create_result
- name: Assert user is created
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.groups | length == 2
- name: Create another user
middleware_automation.keycloak.keycloak_user:
username: "testuser2"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes2
last_name: Untestes2
email: ceciestuntestes2@test.com
state: present
register: create_result2
- name: Get user info
middleware_automation.keycloak.keycloak_realm_users_info:
realm: "{{ ephemeral_realm }}"
register: user_infos
- name: Add missing group info for comparison
ansible.builtin.set_fact:
user_info_with_groups: "{{ [user_infos.users[0] | combine({'groups': ['test', 'test2']}), user_infos.users[1] | combine({'groups': []}) ] }}"
- name: Assert user info is returned correctly
ansible.builtin.assert:
that:
- not user_infos.changed
- "user_info_with_groups == [create_result.end_state, create_result2.end_state]"
@@ -0,0 +1,32 @@
---
description_1: role test desc 1
description_2: role test desc 2
keycloak_role_description: composite role test
keycloak_role_composites:
- name: view-clients
client_id: "realm-management"
state: present
- name: query-clients
client_id: "realm-management"
state: present
- name: offline_access
state: present
keycloak_role_composites_with_aliases:
- name: view-clients
clientId: "realm-management"
state: present
- name: query-clients
clientId: "realm-management"
state: present
- name: offline_access
state: present
keycloak_role_composites_with_absent:
- name: view-clients
client_id: "realm-management"
state: present
- name: query-clients
client_id: "realm-management"
state: present
- name: offline_access
state: absent
@@ -0,0 +1,335 @@
---
# Ported from community.general tests/integration/targets/keycloak_role
# Tests full CRUD lifecycle for realm/client roles and composite role management.
- name: Load role test variables
ansible.builtin.include_vars:
file: vars.yml
# --- Realm role CRUD ---
- name: Create realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert realm role created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == "myrole-test"
- result.end_state.containerId == ephemeral_realm
- name: Create realm role again (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert realm role unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update realm role description
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_2 }}"
state: present
register: result
- name: Assert realm role updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.description == description_1
- result.end_state.description == description_2
- name: Delete realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
state: absent
register: result
- name: Assert realm role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent realm role (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
state: absent
register: result
- name: Assert no change on absent realm role
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Client role CRUD ---
- name: Create client for role tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: myclient
state: present
register: role_test_client
- name: Create client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert client role created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == "client-role-test"
- result.end_state.containerId == role_test_client.end_state.id
- name: Create client role again (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert client role unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update client role description
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_2 }}"
state: present
register: result
- name: Assert client role updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.description == description_1
- result.end_state.description == description_2
- name: Delete client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
state: absent
register: result
- name: Assert client role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent client role (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
state: absent
register: result
- name: Assert no change on absent client role
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Composite realm roles ---
- name: Create realm role with composites
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert realm role created with composites
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 3
- name: Realm role with composites (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert composites unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state.composites | length == 3
- name: Realm composites with aliases (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_aliases }}"
state: present
register: result
- name: Assert composites unchanged with aliases
ansible.builtin.assert:
that:
- result is not changed
- name: Remove one composite from realm role
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_absent }}"
state: present
register: result
- name: Assert composite removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 2
- name: Delete composite realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-role
state: absent
register: result
- name: Assert composite role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent realm role with composites
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-role
state: absent
register: result
- name: Assert not changed and realm role absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Composite client roles ---
- name: Create client role with composites
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert client role created with composites
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 3
- name: Client role with composites (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert client composites unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state.composites | length == 3
- name: Remove one composite from client role
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_absent }}"
state: present
register: result
- name: Assert composite removed from client role
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 2
- name: Delete composite client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-client-role
client_id: myclient
state: absent
register: result
- name: Assert composite client role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent client role with composites
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-client-role
client_id: myclient
state: absent
register: result
- name: Assert not changed and client role absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,19 @@
---
keycloak_username: test
keycloak_user_attributes:
- name: attr1
values:
- value1s
state: present
- name: attr2
values:
- value2s
state: present
- name: attr3
values:
- value3s
state: present
keycloak_user_groups:
- name: test
state: present
- name: test2
@@ -0,0 +1,221 @@
---
# Ported from community.general tests/integration/targets/keycloak_user
# Tests: user with groups+attributes, plus-addressed email, email_verified default reset,
# required_actions explicit reset to empty list.
- name: Load user test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new groups
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ item.name }}"
state: present
loop: "{{ keycloak_user_groups }}"
- name: Create user
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
state: present
register: create_result
- name: Assert user is created
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.userProfileMetadata.attributes | length == 4
- create_result.end_state.groups | length == 2
- name: Delete User
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
state: absent
register: delete_result
- name: Assert user is deleted
ansible.builtin.assert:
that:
- delete_result.changed
- delete_result.end_state | length == 0
- name: Create user with plus-addressed email
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
first_name: Plus
last_name: User
email: "testuser+tag@example.org"
state: present
register: plus_create_result
- name: Assert plus-addressed user is created
ansible.builtin.assert:
that:
- plus_create_result.changed
- plus_create_result.end_state.username == 'testuser+tag'
- plus_create_result.end_state.email == 'testuser+tag@example.org'
- name: Re-run plus-addressed user creation (idempotency)
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
first_name: Plus
last_name: User
email: "testuser+tag@example.org"
state: present
register: plus_idempotent_result
- name: Assert plus-addressed user is idempotent
ansible.builtin.assert:
that:
- plus_idempotent_result is not changed
- name: Delete plus-addressed user
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
state: absent
register: plus_delete_result
- name: Assert plus-addressed user is deleted
ansible.builtin.assert:
that:
- plus_delete_result.changed
- name: Create user again
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
email_verified_behavior: no_defaults
register: create_result
- name: Assert user is created without email_verified
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.emailVerified == false
- name: Set email_verified
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
email_verified: true
state: present
register: create_result
- name: Assert email_verified is set
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.emailVerified == True
- name: Leave email_verified as it is
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
email_verified_behavior: no_defaults
register: create_result
- name: Assert email_verified is still set
ansible.builtin.assert:
that:
- not create_result.changed
- create_result.end_state.emailVerified == True
- name: Test old email_verified behavior
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
register: create_result
- name: Assert email_verified is reset
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.emailVerified == False
- name: Test setting required_actions
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
required_actions:
- UPDATE_PASSWORD
- VERIFY_EMAIL
state: present
register: create_result
- name: Assert required_actions are set
ansible.builtin.assert:
that:
- create_result.changed
- "'UPDATE_PASSWORD' in create_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in create_result.end_state.requiredActions"
- name: Test required_actions unchanged
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
register: create_result
- name: Assert required_actions are still set
ansible.builtin.assert:
that:
- not create_result.changed
- "'UPDATE_PASSWORD' in create_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in create_result.end_state.requiredActions"
- name: Test required_actions reset
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
required_actions: []
register: create_result
- name: Assert required_actions are reset
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.requiredActions == []
@@ -0,0 +1,2 @@
---
federation: myfed
@@ -0,0 +1,352 @@
---
# Ported from community.general tests/integration/targets/keycloak_user_federation
# Tests full LDAP user federation lifecycle: create, idempotency (with masked credentials),
# update with mappers, delete, delete-absent, and create-with-mappers-in-one-step.
- name: Load user federation test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Create new user federation in admin realm
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation created (admin realm)
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Update existing user federation (no change)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Update existing user federation (no change, admin realm)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation unchanged (admin realm)
ansible.builtin.assert:
that:
- result is not changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Update existing user federation (with change)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
mappers:
- name: "username"
providerId: "user-attribute-ldap-mapper"
config:
ldap.attribute: ldap_user
user.model.attribute: usr
read.only: true
- name: "full name"
providerId: "full-name-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.full.name.attribute: cn
read.only: true
write.only: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Delete existing user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
register: result
- name: Assert user federation deleted
ansible.builtin.assert:
that:
- result is changed
- result.existing != {}
- result.end_state == {}
- name: Delete absent user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
register: result
- name: Assert user federation unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.existing == {}
- result.end_state == {}
- name: Create new user federation together with mappers
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
mappers:
- name: "username"
providerId: "user-attribute-ldap-mapper"
config:
ldap.attribute: ldap_user
user.model.attribute: usr
read.only: true
- name: "full name"
providerId: "full-name-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.full.name.attribute: cn
read.only: true
write.only: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Clean up - delete user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
- name: Clean up - delete user federation (admin realm)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: absent
@@ -0,0 +1,5 @@
---
client_id: myclient
client_id_2: myotherclient
test_role: myrole
description_1: desc 1
@@ -0,0 +1,141 @@
---
# Ported from community.general tests/integration/targets/keycloak_user_rolemapping
# Tests service account role mapping (realm and client roles) and cross-client mapping.
- name: Load user rolemapping test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create client with service account for rolemapping test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_accounts_enabled: true
state: present
register: rolemapping_client
- name: Create realm role for service account mapping
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ test_role }}"
description: "{{ description_1 }}"
state: present
- name: Map realm role to client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert realm role is assigned to service account
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap realm role from client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert realm role is unassigned from service account
ansible.builtin.assert:
that:
- result is changed
- (result.end_state | length) == (result.existing | length) - 1
- result.existing | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count > 0
- result.end_state | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count == 0
- name: Delete existing realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ test_role }}"
state: absent
- name: Create second client for cross-client role mapping test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
service_accounts_enabled: true
state: present
register: client_2
- name: Create new client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
name: "{{ test_role }}"
description: "{{ description_1 }}"
state: present
- name: Map client role to user with no existing roles for that client
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id_2 }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert client role is assigned to user with no prior roles
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap the cross-client role mapping
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id_2 }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert cross-client role mapping is removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == []
- name: Map client role to client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert client role is assigned
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap client role from client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert client role is unassigned
ansible.builtin.assert:
that:
- result is changed
- result.end_state == []
- result.existing | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
@@ -0,0 +1,109 @@
---
attributes_default:
- name: username
displayName: "${username}"
validations:
length:
min: 3
max: 255
usernameProhibitedCharacters: {}
up_username_not_idn_homograph: {}
annotations: {}
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: email
displayName: "${email}"
validations:
email: {}
length:
max: 255
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: firstName
displayName: "${firstName}"
validations:
length:
max: 255
personNameProhibitedCharacters: {}
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: lastName
displayName: "${lastName}"
validations:
length:
max: 255
person_name_prohibited_characters: {}
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
attributes_additional:
- name: additionalAttribute
displayName: additionalAttribute
group: user-metadata
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
groups_default:
- name: user-metadata
displayHeader: User metadata
displayDescription: Attributes, which refer to user metadata
config_default:
kc_user_profile_config:
- attributes: "{{ attributes_default }}"
groups: "{{ groups_default }}"
config_updated:
kc_user_profile_config:
- attributes: "{{ attributes_default + attributes_additional }}"
groups: "{{ groups_default }}"
config_unmanaged_attributes_enabled:
kc_user_profile_config:
- unmanagedAttributePolicy: ENABLED
attributes: "{{ attributes_default }}"
config_unmanaged_attributes_admin_edit:
kc_user_profile_config:
- unmanagedAttributePolicy: ADMIN_EDIT
attributes: "{{ attributes_default }}"
config_unmanaged_attributes_admin_view:
kc_user_profile_config:
- unmanagedAttributePolicy: ADMIN_VIEW
attributes: "{{ attributes_default }}"
@@ -0,0 +1,187 @@
---
# Ported from community.general tests/integration/targets/keycloak_userprofile
# Tests full CRUD cycle with check_mode for user profile config,
# switching between unmanaged attribute policies (ENABLED, ADMIN_EDIT, ADMIN_VIEW).
- name: Load user profile config variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create default User Profile (check mode)
middleware_automation.keycloak.keycloak_userprofile:
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
check_mode: true
register: result
- name: Assert User Profile would be created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile would be created"
- name: Create default User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
diff: true
register: result
- name: Assert User Profile was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile created"
- name: Create default User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
register: result
- name: Assert User Profile was in sync
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile was in sync"
- name: Update User Profile (check mode)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
check_mode: true
register: result
- name: Assert User Profile would be changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile would be changed:")
- name: Update User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
diff: true
register: result
- name: Assert User Profile changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
- name: Update User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
register: result
- name: Assert User Profile still in sync
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile was in sync"
- name: Remove User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: absent
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
diff: true
register: result
- name: Assert User Profile was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Userprofile declarative-user-profile deleted"
- name: Remove User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: absent
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
register: result
- name: Assert User Profile not present
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- result.msg == "Userprofile declarative-user-profile not present"
- name: Create User Profile with unmanaged attributes ENABLED
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_enabled }}"
diff: true
register: result
- name: Assert User Profile created with ENABLED policy
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile created"
- name: Change User Profile to unmanaged ADMIN_EDIT
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_admin_edit }}"
diff: true
register: result
- name: Assert User Profile changed to ADMIN_EDIT
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
- name: Change User Profile to unmanaged ADMIN_VIEW
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_admin_view }}"
diff: true
register: result
- name: Assert User Profile changed to ADMIN_VIEW
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
File diff suppressed because it is too large Load Diff
+49
View File
@@ -0,0 +1,49 @@
---
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
roles_path: ../../roles
ssh_connection:
pipelining: false
playbooks:
prepare: ../default/prepare.yml
converge: ../default/converge.yml
verify: verify.yml
inventory:
group_vars:
all:
keycloak_install_requires_become: true
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- verify
- cleanup
- destroy
+1
View File
@@ -0,0 +1 @@
../../roles
+64
View File
@@ -0,0 +1,64 @@
---
- name: Verify use_netrc option prevents .netrc from overriding bearer token (issue 403)
hosts: all
vars:
auth_keycloak_url: http://instance:8080
auth_realm: master
auth_username: remembertochangeme
auth_password: remembertochangeme
target_realm: TestRealm
module_defaults:
group/middleware_automation.keycloak.keycloak:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: "{{ auth_realm }}"
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
validate_certs: false
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"
fail_msg: Keycloak service is not running
- name: Verify netrc handling
block:
- name: Create .netrc with bogus credentials matching the Keycloak host
ansible.builtin.copy:
dest: ~/.netrc
mode: "0600"
content: |
machine instance
login netrc_user
password netrc_password
- name: API call with default use_netrc (false) ignores .netrc
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
realm: "{{ target_realm }}"
register: netrc_default_result
- name: Assert API call succeeds with default use_netrc despite .netrc
ansible.builtin.assert:
that:
- netrc_default_result is not failed
- name: API call with use_netrc true picks up .netrc credentials
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
realm: "{{ target_realm }}"
use_netrc: true
register: netrc_true_result
ignore_errors: true
- name: Assert API call fails when use_netrc is true and .netrc has credentials
ansible.builtin.assert:
that:
- netrc_true_result is failed
always:
- name: Remove .netrc test file
ansible.builtin.file:
path: ~/.netrc
state: absent
+1 -1
View File
@@ -36,7 +36,7 @@
ansible.builtin.set_fact:
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
- name: "Download artefacts only if assets_server is set"
- name: "Download artifacts only if assets_server is set"
when:
- assets_server is defined
- assets_server | length > 0
+5 -5
View File
@@ -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.6.2
keycloak_quarkus_version: 26.7.3
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/26.5.6/spid-provider.jar
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.7.1/spid-provider.jar
- id: spid-saml-w-checksum
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.5.6/spid-provider.jar
checksum: sha256:2ddafc389a5f017d8665bfdfa2f72b3784fc74b9f3a482e796fa89a5ba5cc95b
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.7.1/spid-provider.jar
checksum: sha256:65c16bc70f36af26dac5ab1506b45120674fdf89106320ce00ff53bf6bf1243e
- 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.6.3 # optional
version: 26.7.3 # optional
# username: myUser # optional
# password: myPAT # optional
# - id: my-static-theme
+21
View File
@@ -17,6 +17,27 @@
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
fail_msg: "Service not running"
- name: Read Keycloak sysconfig
ansible.builtin.slurp:
src: /etc/sysconfig/keycloak
register: keycloak_sysconfig
become: "{{ molecule_prepare_require_privilege_escalation | default(true) }}"
- name: Decode Keycloak sysconfig
ansible.builtin.set_fact:
keycloak_sysconfig_text: "{{ keycloak_sysconfig.content | ansible.builtin.b64decode(encoding='utf-8') }}"
- name: Assert sysconfig defers JAVA_OPTS to Keycloak kc.sh defaults
ansible.builtin.assert:
that:
- keycloak_sysconfig_text is search('JAVA_OPTS_KC_HEAP=')
- keycloak_sysconfig_text is search('JAVA_OPTS_APPEND=')
- keycloak_sysconfig_text is not search('(?m)^JAVA_OPTS=')
fail_msg: >-
Expected JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND (not JAVA_OPTS) in sysconfig.
Got:
{{ keycloak_sysconfig_text }}
- name: Set internal envvar
ansible.builtin.set_fact:
hera_home: "{{ lookup('env', 'HERA_HOME') }}"
+18
View File
@@ -0,0 +1,18 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_log: file
keycloak_quarkus_start_dev: true
keycloak_quarkus_hostname_strict: false
keycloak_quarkus_proxy_mode: none
keycloak_quarkus_offline_install: true
keycloak_quarkus_download_path: /tmp/keycloak/
keycloak_quarkus_java_heap_opts: "-Xms640m -Xmx640m"
roles:
- role: keycloak_quarkus
+49
View File
@@ -0,0 +1,49 @@
---
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
ssh_connection:
pipelining: false
playbooks:
prepare: ../default/prepare.yml
inventory:
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- idempotence
- side_effect
- verify
- cleanup
- destroy
+22
View File
@@ -0,0 +1,22 @@
---
- name: Verify
hosts: all
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 health check endpoint is reachable on localhost
ansible.builtin.uri:
url: "http://localhost:8080/realms/master/.well-known/openid-configuration"
method: GET
validate_certs: false
register: keycloak_health_response
until: keycloak_health_response.status == 200
retries: 5
delay: 5
+21
View File
@@ -0,0 +1,21 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_hostname: http://instance:8080/auth
keycloak_quarkus_http_relative_path: /auth
keycloak_quarkus_log: file
keycloak_quarkus_log_level: debug
keycloak_quarkus_log_target: /tmp/keycloak
keycloak_quarkus_start_dev: true
keycloak_quarkus_proxy_mode: none
keycloak_quarkus_offline_install: true
keycloak_quarkus_download_path: /tmp/keycloak/
keycloak_quarkus_java_heap_opts: "-Xms640m -Xmx640m "
roles:
- role: keycloak_quarkus
+50
View File
@@ -0,0 +1,50 @@
---
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
ssh_connection:
pipelining: false
playbooks:
prepare: prepare.yml
converge: converge.yml
verify: verify.yml
inventory:
group_vars:
all:
keycloak_install_requires_become: true
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- idempotence
- side_effect
- verify
- cleanup
- destroy
+29
View File
@@ -0,0 +1,29 @@
---
- 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
- name: Create controller directory for downloads
ansible.builtin.file: # noqa risky-file-permissions delegated, uses controller host user
path: /tmp/keycloak
state: directory
mode: '0750'
delegate_to: localhost
run_once: true
- 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.7.3/keycloak-26.7.3.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
delegate_to: localhost
run_once: true
ignore_errors: true
+1
View File
@@ -0,0 +1 @@
../../roles
+24
View File
@@ -0,0 +1,24 @@
---
- name: Verify
hosts: all
vars:
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_uri: "http://localhost:8080/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 openid endpoint with relative path
ansible.builtin.uri:
url: "{{ keycloak_uri }}/realms/master/.well-known/openid-configuration"
method: GET
validate_certs: no
register: keycloak_openid_response
until: keycloak_openid_response.status == 200
retries: 5
delay: 5
+1 -1
View File
@@ -9,6 +9,6 @@
keycloak_quarkus_additional_env_vars:
- key: KC_FEATURES_DISABLED
value: ciba,device-flow,impersonation,kerberos,docker
keycloak_quarkus_version: 26.6.2
keycloak_quarkus_version: 26.7.3
roles:
- role: keycloak_quarkus
+1 -1
View File
@@ -6,7 +6,7 @@
- vars.yml
vars:
sudo_pkg_name: sudo
keycloak_quarkus_version: 26.6.1
keycloak_quarkus_version: 26.6.2
keycloak_quarkus_additional_env_vars:
- key: KC_FEATURES_DISABLED
value: impersonation,kerberos
+2 -1
View File
@@ -14,7 +14,8 @@ provisioner:
config_options:
defaults:
interpreter_python: auto_silent
callbacks_enabled: profile_tasks, timer, yaml
callbacks_enabled: profile_tasks, timer
callback_result_format: yaml
ssh_connection:
pipelining: false
playbooks:
+52
View File
@@ -6,6 +6,8 @@
keycloak_admin_user: "admin"
keycloak_uri: "http://localhost:8080"
keycloak_context: "/auth"
parent_group: molecule-parent-group
child_group: molecule-child-group
tasks:
- name: Populate service facts
ansible.builtin.service_facts:
@@ -24,3 +26,53 @@
until: keycloak_auth_response.status == 200
retries: 2
delay: 2
# This Keycloak is older than 23, so its group children endpoint accepts no
# GET request and the subgroup lookup has to fall back to the subgroups
# inlined in the parent group representation.
- name: Verify subgroup handling on a pre-23 Keycloak
module_defaults:
group/middleware_automation.keycloak.keycloak:
auth_keycloak_url: "{{ keycloak_uri }}{{ keycloak_context }}"
auth_realm: master
auth_username: "{{ keycloak_admin_user }}"
auth_password: "{{ keycloak_admin_password }}"
validate_certs: false
realm: master
block:
- name: keycloak_group — create parent group
middleware_automation.keycloak.keycloak_group:
name: "{{ parent_group }}"
state: present
- name: keycloak_group — create subgroup below the parent group
middleware_automation.keycloak.keycloak_group:
name: "{{ child_group }}"
parents:
- name: "{{ parent_group }}"
state: present
register: subgroup_result
- name: Assert subgroup was created below the parent group
ansible.builtin.assert:
that:
- subgroup_result is changed
- subgroup_result.end_state.path == '/' ~ parent_group ~ '/' ~ child_group
- name: keycloak_group — look the subgroup up through parents again
middleware_automation.keycloak.keycloak_group:
name: "{{ child_group }}"
parents:
- name: "{{ parent_group }}"
state: present
register: subgroup_lookup_result
- name: Assert the existing subgroup was found instead of re-created
ansible.builtin.assert:
that:
- subgroup_lookup_result is not changed
always:
- name: keycloak_group — remove parent group and its subtree
middleware_automation.keycloak.keycloak_group:
name: "{{ parent_group }}"
state: absent
+8
View File
@@ -78,4 +78,12 @@ options:
- Configures the HTTP User-Agent header.
type: str
default: Ansible
use_netrc:
description:
- Whether to use credentials from C(~/.netrc) file.
- By default, C(~/.netrc) is not used because these modules authenticate via
explicit OIDC credentials/token. A matching C(~/.netrc) entry would silently
override the Bearer token with Basic authentication, causing 401 errors.
type: bool
default: false
'''
@@ -109,6 +109,8 @@ URL_REALM_GROUP_ROLEMAPPINGS = "{url}/admin/realms/{realm}/groups/{group}/role-m
URL_CLIENTSECRET = "{url}/admin/realms/{realm}/clients/{id}/client-secret"
URL_AUTHENTICATION_AUTHENTICATOR_PROVIDERS = "{url}/admin/realms/{realm}/authentication/authenticator-providers"
URL_AUTHENTICATION_CLIENT_AUTHENTICATOR_PROVIDERS = "{url}/admin/realms/{realm}/authentication/client-authenticator-providers"
URL_AUTHENTICATION_FORM_ACTION_PROVIDERS = "{url}/admin/realms/{realm}/authentication/form-action-providers"
URL_AUTHENTICATION_FLOWS = "{url}/admin/realms/{realm}/authentication/flows"
URL_AUTHENTICATION_FLOW = "{url}/admin/realms/{realm}/authentication/flows/{id}"
URL_AUTHENTICATION_FLOW_COPY = "{url}/admin/realms/{realm}/authentication/flows/{copyfrom}/copy"
@@ -177,6 +179,7 @@ def keycloak_argument_spec() -> dict[str, t.Any]:
token=dict(type="str", no_log=True),
refresh_token=dict(type="str", no_log=True),
http_agent=dict(type="str", default="Ansible"),
use_netrc=dict(type="bool", default=False),
)
@@ -216,6 +219,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
http_agent = module_params.get("http_agent")
validate_certs = module_params.get("validate_certs")
connection_timeout = module_params.get("connection_timeout")
use_netrc = module_params.get("use_netrc", False)
try:
r = json.loads(
@@ -226,6 +230,7 @@ def _token_request(module_params: dict[str, t.Any], payload: dict[str, t.Any]) -
http_agent=http_agent,
timeout=connection_timeout,
data=urlencode(payload),
use_netrc=use_netrc,
).read()
)
@@ -401,6 +406,7 @@ class KeycloakAPI:
self.connection_timeout = self.module.params.get("connection_timeout")
self.restheaders = connection_header
self.http_agent = self.module.params.get("http_agent")
self.use_netrc = self.module.params.get("use_netrc", False)
def _request(
self, url: str, method: str, data: str | bytes | None = None, *, extra_headers: dict[str, str] | None = None
@@ -429,6 +435,7 @@ class KeycloakAPI:
headers=headers,
timeout=self.connection_timeout,
validate_certs=self.validate_certs,
use_netrc=self.use_netrc,
)
except HTTPError as e:
if e.code != HTTPStatus.UNAUTHORIZED:
@@ -1731,7 +1738,15 @@ class KeycloakAPI:
except Exception as e:
self.module.fail_json(msg=f"Could not fetch group {gid} in realm {realm}: {e}")
def get_subgroups(self, parent, realm: str = "master"):
def get_subgroups(self, parent, realm: str = "master", search=None):
"""Fetch the direct subgroups of a group.
:param parent: GroupRepresentation of the parent group
:param realm: Realm in which the group resides; default "master"
:param search: Optional group name, letting the server narrow the result
down. This is a hint only: servers which do not support searching
return all subgroups, so callers must still match names themselves.
"""
if "subGroupCount" in parent:
# Since version 23, when GETting a group Keycloak does not
# return subGroups but only a subGroupCount.
@@ -1740,9 +1755,17 @@ class KeycloakAPI:
group_children = []
else:
group_children_url = f"{URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent['id'])}?max={parent['subGroupCount']}"
if search is not None:
# search/exact are only honoured from version 25 on, 23 and 24
# silently ignore them, which is why max is always sent as the
# full child count.
group_children_url += f"&search={quote(search, safe='')}&exact=true"
group_children = self._request_and_deserialize(group_children_url, method="GET")
subgroups = group_children
else:
# Before version 23 the children endpoint has no GET method at all
# (it answers 405 Method Not Allowed), the subgroups are inlined in
# the parent representation instead.
subgroups = parent["subGroups"]
return subgroups
@@ -1750,7 +1773,8 @@ class KeycloakAPI:
"""Fetch a keycloak group within a realm based on its name.
Uses the Keycloak search API with exact matching for efficient lookup
instead of fetching all groups.
instead of fetching all groups. Servers which do not support searching
are handled transparently, see the comments below.
If the group does not exist, None is returned.
:param name: Name of the group to fetch.
@@ -1764,18 +1788,18 @@ class KeycloakAPI:
if not parent:
return None
# For subgroups: use children endpoint with search parameter
search_url = "{url}?search={name}&exact=true".format(
url=URL_GROUP_CHILDREN.format(url=self.baseurl, realm=realm, groupid=parent["id"]),
name=quote(name, safe=""),
)
# For subgroups: search the parent's children where the server
# supports it. get_subgroups knows which servers those are, the
# exact name check below covers the ones which do not.
groups = self.get_subgroups(parent, realm, search=name)
else:
# For top-level groups: use groups endpoint with search parameter
# For top-level groups: use groups endpoint with search parameter.
# exact was only added in version 20; older servers ignore it and return
# substring matches, which the exact name check below sorts out.
search_url = "{url}?search={name}&exact=true".format(
url=URL_GROUPS.format(url=self.baseurl, realm=realm), name=quote(name, safe="")
)
groups = self._request_and_deserialize(search_url, method="GET")
groups = self._request_and_deserialize(search_url, method="GET")
# exact=true should return only exact matches, but verify the name
for group in groups:
@@ -2294,6 +2318,32 @@ class KeycloakAPI:
except Exception as e:
self.fail_request(e, msg=f"Unable get authenticator providers in realm {realm}: {e}")
def get_client_authenticator_providers(self, realm: str = "master"):
"""
Get all available client authenticator providers of the realm.
:param realm: Realm.
:return: List of client authenticator provider representations.
"""
try:
return self._request_and_deserialize(
URL_AUTHENTICATION_CLIENT_AUTHENTICATOR_PROVIDERS.format(url=self.baseurl, realm=realm), method="GET"
)
except Exception as e:
self.fail_request(e, msg=f"Unable get client authenticator providers in realm {realm}: {e}")
def get_form_action_providers(self, realm: str = "master"):
"""
Get all available form action providers of the realm.
:param realm: Realm.
:return: List of form action provider representations.
"""
try:
return self._request_and_deserialize(
URL_AUTHENTICATION_FORM_ACTION_PROVIDERS.format(url=self.baseurl, realm=realm), method="GET"
)
except Exception as e:
self.fail_request(e, msg=f"Unable get form action providers in realm {realm}: {e}")
def get_authentication_flow_by_alias(self, alias, realm: str = "master"):
"""
Get an authentication flow by its alias
+42 -22
View File
@@ -519,6 +519,7 @@ extends_documentation_fragment:
author:
- Thomas Bargetz (@thomasbargetz)
- Nils Bergmann (@NilsBergmann)
"""
EXAMPLES = r"""
@@ -756,8 +757,8 @@ def create_executions(
:param parent_flow_alias: the alias of the flow or sub-flow that will own the executions.
"""
for desired_exec in executions:
sub_flow = desired_exec["subFlow"]
sub_flow_type = desired_exec["subFlowType"]
sub_flow = desired_exec.get("subFlow")
sub_flow_type = desired_exec.get("subFlowType", "basic-flow")
sub_flow_execs = desired_exec.get("authenticationExecutions")
# Build the minimal payload accepted by the execution creation endpoint.
@@ -868,6 +869,12 @@ def existing_auth_to_diff_repr(kc: KeycloakAPI, realm: str, existing_auth: dict)
execution.pop("description", None)
execution.pop("flowId", None)
if execution.get("authenticationFlow"):
# This is always None for non-form-flows and defaults to 'registration-page-form' for form-flows.
# Keycloak supports custom form-flow providers via the FormAuthenticatorFactory SPI, but this module has no
# option to choose one, so the providerId is stripped from the existing execution before comparison.
execution.pop("providerId", None)
if execution.get("authenticationConfig") is not None:
execution["authenticationConfig"].pop("id", None)
# The alias is already stored inside the authenticationConfig object; the
@@ -1052,33 +1059,46 @@ def create_authentication_execution_spec_options(depth: int) -> dict[str, t.Any]
return options
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict) -> None:
valid_providers = kc.get_authenticator_providers(realm)
valid_provider_ids = {provider["id"] for provider in valid_providers}
def validate_executions(kc: KeycloakAPI, realm: str, executions: dict, flow_type: str) -> None:
valid_provider_ids_by_flow_type = {
"basic-flow": {provider["id"] for provider in kc.get_authenticator_providers(realm)},
"form-flow": {provider["id"] for provider in kc.get_form_action_providers(realm)},
"client-flow": {provider["id"] for provider in kc.get_client_authenticator_providers(realm)},
}
all_known_provider_ids = set().union(*valid_provider_ids_by_flow_type.values())
invalid_provider_ids = validate_executions_rec(valid_provider_ids, executions)
if len(invalid_provider_ids) > 0:
invalid_provider_ids_str = ", ".join(f"'{item}'" for item in invalid_provider_ids)
raise ValueError(
f"The following execution providerIds are unknown and therefore invalid: {invalid_provider_ids_str}"
)
messages = []
has_issues = validate_executions_rec(valid_provider_ids_by_flow_type, all_known_provider_ids, executions, flow_type, messages)
if has_issues:
raise ValueError("Error(s) while validating flow: " + ", ".join(messages))
def validate_executions_rec(valid_provider_ids: set, executions: dict) -> list:
invalid_provider_ids = []
def validate_executions_rec(
valid_provider_ids_by_flow_type: dict, all_known_provider_ids: set, executions: dict, flow_type: str, messages: list
) -> bool:
if flow_type not in valid_provider_ids_by_flow_type:
messages.append(f"Unsupported flow type '{flow_type}'")
return True
has_issues = False
valid_provider_ids = valid_provider_ids_by_flow_type[flow_type]
for execution in executions:
provider_id = execution["providerId"]
sub_flow = execution["subFlow"]
if provider_id is not None:
if provider_id not in valid_provider_ids:
invalid_provider_ids.append(provider_id)
sub_flow = execution.get("subFlow")
if provider_id is not None and provider_id not in valid_provider_ids:
has_issues = True
if provider_id in all_known_provider_ids:
messages.append(f"'{provider_id}' is not a valid provider for parent flow '{flow_type}'")
else:
messages.append(f"Unknown providerId '{provider_id}'")
if sub_flow is not None:
invalid_provider_ids.extend(
validate_executions_rec(valid_provider_ids, execution["authenticationExecutions"])
)
if validate_executions_rec(
valid_provider_ids_by_flow_type, all_known_provider_ids, execution["authenticationExecutions"], execution["subFlowType"], messages
):
has_issues = True
return invalid_provider_ids
return has_issues
def main() -> None:
@@ -1141,7 +1161,7 @@ def main() -> None:
try:
try:
validate_executions(kc, realm, desired_auth["authenticationExecutions"])
validate_executions(kc, realm, desired_auth["authenticationExecutions"], desired_auth["providerId"])
except ValueError as e:
module.fail_json(
msg=f"Validation of executions failed: {e}",
+12 -7
View File
@@ -339,11 +339,10 @@ def main():
role["id"] = role_id
else:
module.fail_json(msg=f"Could not fetch role {role['name']}:")
# Fetch missing role_name
else:
role["name"] = kc.get_client_group_rolemapping_by_id(gid, cid, role["id"], realm=realm)["name"]
if role["name"] is None:
module.fail_json(msg=f"Could not fetch role {role['id']}")
# Fetch missing role_name from the client's roles, not from existing group mappings
elif role["name"] is None:
role_rep = kc.get_role_by_id(role["id"], realm=realm)
role["name"] = role_rep["name"]
# Get effective client-level role mappings
available_roles_before = kc.get_client_group_available_rolemappings(gid, cid, realm=realm)
@@ -383,7 +382,10 @@ def main():
# Assign roles
result["changed"] = True
if module._diff:
result["diff"] = dict(before=assigned_roles_before, after=result["proposed"])
result["diff"] = dict(
before={"roles": assigned_roles_before or []},
after={"roles": result["proposed"]},
)
if module.check_mode:
module.exit_json(**result)
kc.add_group_rolemapping(gid, cid, update_roles, realm=realm)
@@ -395,7 +397,10 @@ def main():
# Remove mapping of role
result["changed"] = True
if module._diff:
result["diff"] = dict(before=assigned_roles_before, after=result["proposed"])
result["diff"] = dict(
before={"roles": assigned_roles_before or []},
after={"roles": result["proposed"]},
)
if module.check_mode:
module.exit_json(**result)
kc.delete_group_rolemapping(gid, cid, update_roles, realm=realm)
+11 -3
View File
@@ -83,6 +83,8 @@ options:
description:
- A list of protocol mappers to associate with the client scope.
- Each mapper is a dict with the keys C(name), C(protocol), C(protocolMapper), and C(config).
aliases:
- protocolMappers
default: []
suboptions:
name:
@@ -204,15 +206,21 @@ def main():
realm=dict(type='str', default='master'),
protocol=dict(type='str', default='openid-connect', choices=['openid-connect', 'saml']),
attributes=dict(type='dict'),
protocol_mappers=dict(type='list', default=[], options=mapper_spec, elements='dict'),
protocol_mappers=dict(type='list', default=[], options=mapper_spec, elements='dict', aliases=['protocolMappers']),
)
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']]),
required_together=([['auth_realm', 'auth_username', 'auth_password']]))
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"},
mutually_exclusive=[["token", "auth_realm"], ["token", "auth_username"], ["token", "auth_password"]])
result = dict(changed=False, msg='', diff={}, end_state={})
+11
View File
@@ -53,6 +53,10 @@ options:
description:
- Name of the group.
- This parameter is required only when creating or updating the group.
description:
type: str
description:
- Description of the group.
realm:
type: str
description:
@@ -298,6 +302,11 @@ end_state:
manage: true
manageMembership: true
view: true
description:
description: A description of the group as string.
type: str
returned: when present
sample: An example group description
"""
from ansible.module_utils.basic import AnsibleModule
@@ -324,6 +333,7 @@ def main():
realm=dict(default="master"),
id=dict(type="str"),
name=dict(type="str"),
description=dict(type="str"),
attributes=dict(type="dict"),
parents=dict(
type="list",
@@ -361,6 +371,7 @@ def main():
state = module.params.get("state")
gid = module.params.get("id")
name = module.params.get("name")
description = module.params.get("description")
attributes = module.params.get("attributes")
parents = module.params.get("parents")
@@ -244,6 +244,12 @@ options:
- Way to identify and track external users from the assertion.
type: str
doNotStoreUsers:
description:
- If V(true), users authenticating through this identity provider will not be stored in the Keycloak database.
- This requires the C(transient-users) feature to be enabled on the Keycloak server (available since Keycloak 23).
type: bool
fromUrl:
description:
- IDP well-known OpenID Connect configuration URL.
@@ -372,6 +378,25 @@ EXAMPLES = r"""
attribute.name: roles
syncMode: INHERIT
- name: Create OIDC identity provider with transient users (do not store users in database)
middleware_automation.keycloak.keycloak_identity_provider:
state: present
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: admin
auth_password: admin
realm: myrealm
alias: oidc-idp
display_name: OpenID Connect IdP
enabled: true
provider_id: oidc
config:
fromUrl: https://the-idp.example.com/realms/idprealm/.well-known/openid-configuration
clientAuthMethod: client_secret_post
clientId: my-client
clientSecret: secret
doNotStoreUsers: true
- name: Create OIDC identity provider, authentication with credentials and advanced claim to group
middleware_automation.keycloak.keycloak_identity_provider:
state: present
+7
View File
@@ -327,6 +327,12 @@ options:
aliases:
- maxFailureWaitSeconds
type: int
max_secondary_auth_failures:
description:
- The realm max secondary authentication failures (used with brute force detection for secondary auth mechanisms).
aliases:
- maxSecondaryAuthFailures
type: int
max_temporary_lockouts:
description:
- The realm max temporary lockouts.
@@ -914,6 +920,7 @@ def main():
login_with_email_allowed=dict(type="bool", aliases=["loginWithEmailAllowed"]),
max_delta_time_seconds=dict(type="int", aliases=["maxDeltaTimeSeconds"]),
max_failure_wait_seconds=dict(type="int", aliases=["maxFailureWaitSeconds"]),
max_secondary_auth_failures=dict(type="int", aliases=["maxSecondaryAuthFailures"]),
max_temporary_lockouts=dict(type="int", aliases=["maxTemporaryLockouts"]),
minimum_quick_login_wait_seconds=dict(type="int", aliases=["minimumQuickLoginWaitSeconds"]),
not_before=dict(type="int", aliases=["notBefore"]),
+1 -1
View File
@@ -620,7 +620,7 @@ def get_keycloak_config_key(param_name, provider_id=None):
"""
# Handle elliptic_curve specially - each provider uses a different config key
if param_name == "elliptic_curve" and provider_id in ELLIPTIC_CURVE_CONFIG_KEYS:
return ELLIPTIC_CURVE_CONFIG_KEYS[param_name]
return ELLIPTIC_CURVE_CONFIG_KEYS[provider_id]
if param_name in CONFIG_PARAM_MAPPING:
return CONFIG_PARAM_MAPPING[param_name]
return camel(param_name)
+9 -1
View File
@@ -512,6 +512,7 @@ def main():
"groups",
"clientConsents",
"federatedIdentities",
"state",
]
if state == "absent":
@@ -554,9 +555,16 @@ def main():
# Add user ID to new representation
desired_user["id"] = before_user["id"]
before_user_for_compare = before_user
if "attributes" in changeset and "attributes" in before_user:
before_user_for_compare = before_user.copy()
before_user_for_compare["attributes"] = kc.convert_keycloak_user_attributes_dict_to_module_list(
attributes=before_user["attributes"]
)
# Compare users
if not (
is_struct_included(desired_user, before_user, user_compare_excludes, empty_list_result=False)
is_struct_included(desired_user, before_user_for_compare, user_compare_excludes, empty_list_result=False)
): # If the new user introduces a change to the existing user
# Update the user
if not module.check_mode:
+15 -1
View File
@@ -989,12 +989,14 @@ def main():
else:
old_mapper = {}
new_mapper = old_mapper.copy()
old_mapper_config = old_mapper.get("config", {})
new_mapper.update(change)
if "config" in change and old_mapper_config:
new_mapper["config"] = {**old_mapper_config, **change["config"]}
# changeset contains all desired mappers: those existing, to update or to create
if changeset.get("mappers") is None:
changeset["mappers"] = list()
changeset["mappers"].append(new_mapper)
changeset["mappers"] = sorted(changeset["mappers"], key=lambda x: x.get("name") or "")
# to keep unspecified existing mappers we add them to the desired mappers list, unless they're already present
if not module.params["remove_unspecified_mappers"] and "mappers" in before_comp:
@@ -1003,10 +1005,19 @@ def main():
[mapper for mapper in before_comp["mappers"] if mapper["id"] not in changeset_mapper_ids]
)
# ensure idempotency in case module.params.mappers is not sorted by name
changeset["mappers"] = sorted(changeset["mappers"], key=lambda x: x.get("name") or "")
# Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
desired_comp = before_comp.copy()
desired_comp.update(changeset)
# Merge config: preserve KC-internal config keys not managed by this module
if "config" in changeset and "config" in before_comp:
merged_config = deepcopy(before_comp["config"])
merged_config.update(changeset["config"])
desired_comp["config"] = merged_config
result["proposed"] = sanitize(changeset)
result["existing"] = sanitize(before_comp)
@@ -1050,7 +1061,10 @@ def main():
old_mapper = {}
new_mapper = old_mapper.copy()
old_default_config = old_mapper.get("config", {})
new_mapper.update(desired_mapper)
if "config" in desired_mapper and old_default_config:
new_mapper["config"] = {**old_default_config, **desired_mapper["config"]}
if new_mapper.get("id") is not None:
kc.update_component(new_mapper, realm)
+34 -31
View File
@@ -337,38 +337,9 @@ def main():
module.fail_json(msg=f"Could not fetch client {client_id}:")
if roles is None:
module.exit_json(msg="Nothing to do (no roles specified).")
else:
for role in roles:
if role.get("name") is None and role.get("id") is None:
module.fail_json(msg="Either the `name` or `id` has to be specified on each role.")
# Fetch missing role_id
if role.get("id") is None:
if cid is None:
role_id = kc.get_realm_role(name=role.get("name"), realm=realm)["id"]
else:
role_id = kc.get_client_role_id_by_name(cid=cid, name=role.get("name"), realm=realm)
if role_id is not None:
role["id"] = role_id
else:
module.fail_json(
msg=f"Could not fetch role {role.get('name')} for client_id {client_id} or realm {realm}"
)
# Fetch missing role_name
else:
if cid is None:
role_rep = kc.get_realm_user_rolemapping_by_id(uid=uid, rid=role.get("id"), realm=realm)
if role_rep is not None:
role["name"] = role_rep["name"]
else:
role_rep = kc.get_client_user_rolemapping_by_id(uid=uid, cid=cid, rid=role.get("id"), realm=realm)
if role_rep is not None:
role["name"] = role_rep["name"]
if role.get("name") is None:
module.fail_json(
msg=f"Could not fetch role {role.get('id')} for client_id {client_id} or realm {realm}"
)
# Get effective role mappings
# Get available and assigned role mappings using user-scoped endpoints
# (these do not require the view-realm permission)
if cid is None:
available_roles_before = kc.get_realm_user_available_rolemappings(uid=uid, realm=realm)
assigned_roles_before = kc.get_realm_user_composite_rolemappings(uid=uid, realm=realm)
@@ -376,6 +347,38 @@ def main():
available_roles_before = kc.get_client_user_available_rolemappings(uid=uid, cid=cid, realm=realm)
assigned_roles_before = kc.get_client_user_composite_rolemappings(uid=uid, cid=cid, realm=realm)
all_known_roles = available_roles_before + assigned_roles_before
for role in roles:
if role.get("name") is None and role.get("id") is None:
module.fail_json(msg="Either the `name` or `id` has to be specified on each role.")
# Fetch missing role_id
if role.get("id") is None:
role_id = None
for r in all_known_roles:
if r["name"] == role.get("name"):
role_id = r["id"]
break
if role_id is not None:
role["id"] = role_id
else:
module.fail_json(
msg=f"Could not fetch role {role.get('name')} for client_id {client_id} or realm {realm}"
)
# Fetch missing role_name
elif role.get("name") is None:
role_name = None
for r in all_known_roles:
if r["id"] == role.get("id"):
role_name = r["name"]
break
if role_name is not None:
role["name"] = role_name
else:
module.fail_json(
msg=f"Could not fetch role {role.get('id')} for client_id {client_id} or realm {realm}"
)
result["existing"] = assigned_roles_before
result["proposed"] = roles
+2 -1
View File
@@ -116,7 +116,7 @@ Role Defaults
|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port + keycloak_jboss_port_offset }}` |
|`keycloak_frontend_url_force` | Force backend requests to use the frontend URL | `false` |
|`keycloak_db_background_validation` | Enable background validation of database connection | `false` |
|`keycloak_db_background_validation_millis`| How frequenly the connection pool is validated in the background | `10000` if background validation enabled |
|`keycloak_db_background_validation_millis`| How frequently the connection pool is validated in the background | `10000` if background validation enabled |
|`keycloak_db_background_validate_on_match` | Enable validate on match for database connections | `false` |
|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` |
|`keycloak_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` |
@@ -210,6 +210,7 @@ Apache License 2.0
Author Information
------------------
* [Ranabir Chakraborty](https://github.com/RanabirChakraborty)
* [Guido Grazioli](https://github.com/guidograzioli)
* [Romain Pelisse](https://github.com/rpelisse)
* [Pavan Kumar Motaparthi](https://github.com/motaparthipavankumar)
+1 -1
View File
@@ -60,7 +60,7 @@ keycloak_features: []
keycloak_ha_enabled: false
### Enable database configuration, must be enabled when HA is configured
keycloak_db_enabled: "{{ True if keycloak_ha_enabled else False }}"
### Discovery protocol for ha cluster members, valus [ 'JDBC_PING', 'TCPPING' ]
### Discovery protocol for ha cluster members, values [ 'JDBC_PING', 'TCPPING' ]
keycloak_ha_discovery: "{{ 'JDBC_PING' if keycloak_db_enabled else 'TCPPING' }}"
### Remote cache store on infinispan cluster
keycloak_remote_cache_enabled: "{{ True if keycloak_ha_enabled else False }}"
+1 -1
View File
@@ -296,7 +296,7 @@ argument_specs:
type: "bool"
keycloak_db_background_validation_millis:
default: "{{ 10000 if keycloak_db_background_validation else 0 }}"
description: "How frequenly the connection pool is validated in the background"
description: "How frequently the connection pool is validated in the background"
type: 'int'
keycloak_db_background_validate_on_match:
default: false
+2 -2
View File
@@ -256,8 +256,8 @@
{
"name": item,
"address": 'jgroups-' + item,
"inventory_host": hostvars[item].ansible_default_ipv4.address | default(item) + '[' + (keycloak_jgroups_port | string) + ']',
"value": hostvars[item].ansible_default_ipv4.address | default(item)
"inventory_host": hostvars[item].ansible_facts['default_ipv4']['address'] | default(item) + '[' + (keycloak_jgroups_port | string) + ']',
"value": hostvars[item].ansible_facts['default_ipv4']['address'] | default(item)
}
] }}
loop: "{{ ansible_play_batch }}"
+1 -1
View File
@@ -11,7 +11,7 @@
- name: Distro specific tasks
ansible.builtin.include_tasks:
file: "{{ ansible_os_family | lower }}.yml"
file: "{{ ansible_facts['os_family'] | lower }}.yml"
apply:
tags:
- unbound
+4 -4
View File
@@ -42,13 +42,13 @@
- name: Validate OS family
ansible.builtin.assert:
that:
- ansible_os_family in ["RedHat", "Debian"]
- ansible_facts['os_family'] in ["RedHat", "Debian"]
quiet: true
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_os_family }}"
success_msg: "Installing on {{ ansible_os_family }}"
fail_msg: "Can only install on RedHat or Debian OS families; found {{ ansible_facts['os_family'] }}"
success_msg: "Installing on {{ ansible_facts['os_family'] }}"
- name: Load OS specific variables
ansible.builtin.include_vars: "vars/{{ ansible_os_family | lower }}.yml"
ansible.builtin.include_vars: "vars/{{ ansible_facts['os_family'] | lower }}.yml"
tags:
- always

Some files were not shown because too many files have changed in this diff Show More