Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

keycloak_user_federation: add user federation config parameter referral to module args #8954

Merged
merged 4 commits into from
Oct 7, 2024
Merged

keycloak_user_federation: add user federation config parameter referral to module args #8954

merged 4 commits into from
Oct 7, 2024

Conversation

fgruenbauer
Copy link
Contributor

@fgruenbauer fgruenbauer commented Oct 1, 2024 •
edited
Loading

SUMMARY

The module is missing support for the config.referral parameter. The PR adds the parameter to the user federation config.

Module args:

  community.general.keycloak_user_federation:
    [...]
    state: present
    config:
      referral: "follow"
      [...]

Not supported response:

fatal: [kc1]: FAILED! => {"changed": false, "msg": "Unsupported parameters for (community.general.keycloak_user_federation) module: config.referral. Supported parameters include: allowKerberosAuthentication, allowPasswordAuthentication, authType, batchSizeForSync, bindCredential, bindDn, cachePolicy, changedSyncPeriod, connectionPooling, connectionPoolingAuthentication, connectionPoolingDebug, connectionPoolingInitSize, connectionPoolingMaxSize, connectionPoolingPrefSize, connectionPoolingProtocol, connectionPoolingTimeout, connectionTimeout, connectionUrl, customUserSearchFilter, debug, editMode, enabled, evictionDay, evictionHour, evictionMinute, fullSyncPeriod, importEnabled, kerberosRealm, keyTab, krbPrincipalAttribute, maxLifespan, pagination, priority, rdnLDAPAttribute, readTimeout, searchScope, serverPrincipal, startTls, syncRegistrations, trustEmail, updateProfileFirstLogin, useKerberosForPasswordAuthentication, usePasswordModifyExtendedOp, useTruststoreSpi, userObjectClasses, usernameLDAPAttribute, usersDn, uuidLDAPAttribute, validatePasswordPolicy, vendor."}

With support:

--- before
+++ after
@@ -21,7 +21,7 @@
         "pagination": "false",
         "priority": "0",
         "rdnLDAPAttribute": "sAMAccountName",
-        "referral": "ignore",
+        "referral": "follow",
         "searchScope": "2",
         "serverPrincipal": "HTTP/[email protected]",
         "startTls": "false",

changed: [kc1]
ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

keycloak_user_federation

ADDITIONAL INFORMATION
  1. add referral: follow to user federation config
  2. run module

@ansibullbot
Copy link
Collaborator

cc @eikef @laurpaum @mattock @ndclt @thomasbach-dev
click here for bot help

@ansibullbot ansibullbot added bug This issue/PR relates to a bug module module plugins plugin (any type) labels Oct 1, 2024
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-8 Automatically create a backport for the stable-8 branch backport-9 Automatically create a backport for the stable-9 branch and removed backport-8 Automatically create a backport for the stable-8 branch labels Oct 1, 2024
felixfontein
felixfontein reviewed Oct 1, 2024
View reviewed changes
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

plugins/modules/keycloak_user_federation.py Show resolved Hide resolved
changelogs/fragments/8954-keycloak-user-federation-add-referral-parameter.yml Outdated Show resolved Hide resolved
@felixfontein
Copy link
Collaborator

Looks good to me. If nobody objects, I'll merge this next week.

russoz
russoz approved these changes Oct 4, 2024
View reviewed changes
Copy link
Collaborator

@russoz russoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Oct 7, 2024
@felixfontein felixfontein merged commit c7e2875 into ansible-collections:main Oct 7, 2024
141 checks passed
@patchback Patchback
Copy link

patchback bot commented Oct 7, 2024 •
edited
Loading

Backport to stable-9: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-9/c7e2875a4d8a92e81ff09d037a206e2eae8cfdae/pr-8954

Backported as #8997

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Oct 7, 2024
@fgruenbauer @patchback
keycloak_user_federation: add user federation config parameter `refer…
0f203ea 
…ral` to module args (#8954)

* add keycloak referral parameter to module args

* add changelog fragment

* Update plugins/modules/keycloak_user_federation.py

Co-authored-by: Felix Fontein <[email protected]>

* Update changelogs/fragments/8954-keycloak-user-federation-add-referral-parameter.yml

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit c7e2875)
@patchback patchback bot mentioned this pull request Oct 7, 2024
Merged
@felixfontein
Copy link
Collaborator

@fgruenbauer thanks for your contribution!
@russoz thanks for reviewing!

felixfontein pushed a commit that referenced this pull request Oct 7, 2024
@patchback @fgruenbauer
[PR #8954/c7e2875a backport][stable-9] keycloak_user_federation: add …
dc5a89b 
…user federation config parameter `referral` to module args (#8997)

keycloak_user_federation: add user federation config parameter `referral` to module args (#8954)

* add keycloak referral parameter to module args

* add changelog fragment

* Update plugins/modules/keycloak_user_federation.py

Co-authored-by: Felix Fontein <[email protected]>

* Update changelogs/fragments/8954-keycloak-user-federation-add-referral-parameter.yml

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit c7e2875)

Co-authored-by: fgruenbauer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixfontein felixfontein felixfontein left review comments

@russoz russoz russoz approved these changes

Assignees
No one assigned
Labels
backport-9 Automatically create a backport for the stable-9 branch bug This issue/PR relates to a bug module module plugins plugin (any type)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@fgruenbauer @ansibullbot @felixfontein @russoz