New Module: Keycloak ClientSecret #3997

fynncfchen · 2022-01-06T16:47:53Z

SUMMARY

Add keycloak_clientsecret to provide management of client secret via Keycloak Admin API.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

keycloak_clientsecret

ADDITIONAL INFORMATION

Example:

- name: Get a Keycloak client secret, authentication with credentials
  community.general.keycloak_clientsecret:
    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
    realm: MyCustomRealm
    state: present
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
  delegate_to: localhost

- name: Generate a new Keycloak client secret, authentication with token
  community.general.keycloak_user:
    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
    realm: MyCustomRealm
    state: absent
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
  delegate_to: localhost

…ecret

ansibullbot · 2022-01-06T16:54:32Z

cc @eikef @ndclt
click here for bot help

felixfontein · 2022-01-22T07:19:13Z

CC @pmdumuid @laurpaum

plugins/modules/identity/keycloak/keycloak_clientsecret.py

Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein · 2022-02-14T19:00:40Z

plugins/module_utils/identity/keycloak/keycloak.py

+
+        try:
+            return json.loads(to_native(open_url(clientsecret_url, method='POST', headers=self.restheaders,
+                                                 validate_certs=self.validate_certs).read()))


This (and others) need to be adjusted similar to #4178.

felixfontein · 2022-04-23T09:53:09Z

needs_info

felixfontein · 2022-04-26T20:09:29Z

This New Module PR contains a symbolic link from plugins/modules/ to the actual Python file. Since #4562 this is no longer necessary and will soon be flagged as an error. Instead you need to add an entry to meta/runtime.yml, similar to this one: https://github.com/ansible-collections/community.general/blob/main/meta/runtime.yml#L21-L22

See also our updated instructions on creating new modules: https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md#creating-new-modules-or-plugins

russoz

Hi @fynncfchen , thanks for your contribution. I am leaving a couple of suggestions around, but they don't affect the outcome of the module itself. Other than that (and Felix's comments), looking good.

russoz · 2022-05-23T10:00:55Z

plugins/modules/identity/keycloak/keycloak_clientsecret.py

+'''
+
+RETURN = '''
+msg:


It would be Nice-to-Have(TM) consistency in the indentation on the YAML blocks. In some places it is 2 spaces, in others 4 spaces.

russoz · 2022-05-23T10:05:20Z

plugins/modules/identity/keycloak/keycloak_clientsecret.py

+        result['end_state'] = clientsecret
+        result['msg'] = 'Get client secret successful for ID {id}'.format(id=id)
+
+        module.exit_json(**result)


This line is redundant, as the exact same command will run after the if-else block in line 232

russoz · 2022-05-23T10:05:34Z

plugins/modules/identity/keycloak/keycloak_clientsecret.py

+        result['changed'] = False
+        result['end_state'] = {}
+        result['msg'] = 'State not specified; doing nothing.'
+        module.exit_json(**result)


This line is redundant, as the exact same command will run after the if-else block in line 232

russoz · 2022-05-23T10:07:55Z

plugins/modules/identity/keycloak/keycloak_clientsecret.py

+    # only lookup the client_id if id isn't provided.
+    # in the case that both are provided, prefer the ID, since it's one
+    # less lookup.
+    if id is None and client_id is not None:


Because of the required_one_of spec in the Module, on line 165, this could be simplified to:

Suggested change

if id is None and client_id is not None:

if id is None:

russoz · 2022-05-23T10:16:18Z

plugins/modules/identity/keycloak/keycloak_clientsecret.py

+
+    argument_spec.update(meta_args)
+
+    module = AnsibleModule(argument_spec=argument_spec,


From the examples, it looks like one must pass (auth_realm, auth_username, auth_password) or token, but not both.

If that's indeed the case, there should be a mutually_exclusive clause here.

ansibullbot · 2022-05-31T10:29:20Z

@fynncfchen This pullrequest is waiting for your response. Please respond or the pullrequest will be closed.

click here for bot help

ansibullbot · 2022-07-02T10:57:41Z

@fynncfchen You have not responded to information requests in this pullrequest so we will assume it no longer affects you. If you are still interested in this, please create a new pullrequest with the requested information.

click here for bot help

github-actions · 2022-07-02T11:09:11Z

Docs Build 📝

This PR is closed and any previously published docsite has been unpublished.

johncant · 2022-11-25T16:37:46Z

I would find the functionality in this PR by @fynncfchen useful. @russoz - would you merge if I made your changes?

russoz · 2022-11-25T19:30:39Z

Hi @johncant , that's the purpose of PRs :).

Just read it carefully, as Felix has also requested some changes as well.

johncant · 2022-11-26T16:55:57Z

Thanks @russoz @felixfontein @fynncfchen - now done!

fynncfchen added 2 commits January 7, 2022 00:43

feat(plugins/keycloak): add get and create util function for client s…

aac0a40

…ecret

feat(plugins/keycloak): add client secret module

61bfc12

ansibullbot added identity module module module_utils module_utils new_contributor Help guide this first time contributor new_plugin New plugin plugins plugin (any type) labels Jan 6, 2022

This comment has been minimized.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jan 6, 2022

felixfontein added backport-4 check-before-release PR will be looked at again shortly before release and merged if possible. labels Jan 6, 2022

chore: add maintainer in BOTMETA

ed6952b

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jan 7, 2022

fynncfchen changed the title ~~Feature: Keycloak ClientSecret~~ New Plugin: Keycloak ClientSecret Jan 8, 2022

fynncfchen changed the title ~~New Plugin: Keycloak ClientSecret~~ New Module: Keycloak ClientSecret Jan 8, 2022

ansibullbot added stale_ci CI is older than 7 days, rerun before merging and removed new_contributor Help guide this first time contributor labels Jan 16, 2022

felixfontein reviewed Jan 24, 2022

View reviewed changes

plugins/modules/identity/keycloak/keycloak_clientsecret.py Outdated Show resolved Hide resolved

Update plugins/modules/identity/keycloak/keycloak_clientsecret.py

7a9375b

Co-authored-by: Felix Fontein <felix@fontein.de>

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Feb 1, 2022

felixfontein reviewed Feb 14, 2022

View reviewed changes

ansibullbot added the needs_info This issue requires further information. Please answer any outstanding questions label Apr 23, 2022

felixfontein removed the backport-4 label Apr 27, 2022

russoz reviewed May 23, 2022

View reviewed changes

ansibullbot closed this Jul 2, 2022

johncant mentioned this pull request Nov 26, 2022

New Module: Keycloak ClientSecret with PR changes #5606

Merged

patchback bot mentioned this pull request Dec 5, 2022

[PR #5606/7ea544a6 backport][stable-6] New Module: Keycloak ClientSecret with PR changes #5654

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Module: Keycloak ClientSecret #3997

New Module: Keycloak ClientSecret #3997

fynncfchen commented Jan 6, 2022

ansibullbot commented Jan 6, 2022

This comment has been minimized.

felixfontein commented Jan 22, 2022

felixfontein Feb 14, 2022

felixfontein commented Apr 23, 2022

felixfontein commented Apr 26, 2022

russoz left a comment

russoz May 23, 2022

russoz May 23, 2022

russoz May 23, 2022

russoz May 23, 2022

russoz May 23, 2022

ansibullbot commented May 31, 2022

ansibullbot commented Jul 2, 2022

github-actions bot commented Jul 2, 2022

johncant commented Nov 25, 2022

russoz commented Nov 25, 2022

johncant commented Nov 26, 2022


		argument_spec.update(meta_args)

		module = AnsibleModule(argument_spec=argument_spec,

New Module: Keycloak ClientSecret #3997

New Module: Keycloak ClientSecret #3997

Conversation

fynncfchen commented Jan 6, 2022

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Jan 6, 2022

This comment has been minimized.

felixfontein commented Jan 22, 2022

felixfontein Feb 14, 2022

Choose a reason for hiding this comment

felixfontein commented Apr 23, 2022

felixfontein commented Apr 26, 2022

russoz left a comment

Choose a reason for hiding this comment

russoz May 23, 2022

Choose a reason for hiding this comment

russoz May 23, 2022

Choose a reason for hiding this comment

russoz May 23, 2022

Choose a reason for hiding this comment

russoz May 23, 2022

Choose a reason for hiding this comment

russoz May 23, 2022

Choose a reason for hiding this comment

ansibullbot commented May 31, 2022

ansibullbot commented Jul 2, 2022

github-actions bot commented Jul 2, 2022

Docs Build 📝

johncant commented Nov 25, 2022

russoz commented Nov 25, 2022

johncant commented Nov 26, 2022