ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-16 17:01:30 +00:00
Code Activity

Reformat everything.

Browse source
This commit is contained in:
Felix Fontein 2025-11-01 12:08:41 +01:00
parent 3f2213791a
commit 340ff8586d
1008 changed files with 61301 additions and 58309 deletions
Download patch file Download diff file Expand all files Collapse all files

133
plugins/modules/keycloak_authz_authorization_scope.py
View file

@ -123,8 +123,12 @@ end_state:
sample: http://localhost/icon.png
"""
from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, \
keycloak_argument_spec, get_token, KeycloakError
from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import (
KeycloakAPI,
keycloak_argument_spec,
get_token,
KeycloakError,
)
from ansible.module_utils.basic import AnsibleModule
@ -137,26 +141,27 @@ def main():
argument_spec = keycloak_argument_spec()
meta_args = dict(
state=dict(type='str', default='present',
choices=['present', 'absent']),
name=dict(type='str', required=True),
display_name=dict(type='str'),
icon_uri=dict(type='str'),
client_id=dict(type='str', required=True),
realm=dict(type='str', required=True)
state=dict(type="str", default="present", choices=["present", "absent"]),
name=dict(type="str", required=True),
display_name=dict(type="str"),
icon_uri=dict(type="str"),
client_id=dict(type="str", required=True),
realm=dict(type="str", required=True),
)
argument_spec.update(meta_args)
module = AnsibleModule(argument_spec=argument_spec,
supports_check_mode=True,
required_one_of=(
[['token', 'auth_realm', 'auth_username', 'auth_password', 'auth_client_id', 'auth_client_secret']]),
required_together=([['auth_username', 'auth_password']]),
required_by={'refresh_token': 'auth_realm'},
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
required_one_of=(
[["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"]]
),
required_together=([["auth_username", "auth_password"]]),
required_by={"refresh_token": "auth_realm"},
)
result = dict(changed=False, msg='', end_state={}, diff=dict(before={}, after={}))
result = dict(changed=False, msg="", end_state={}, diff=dict(before={}, after={}))
# Obtain access token, initialize API
try:
@ -167,49 +172,48 @@ def main():
kc = KeycloakAPI(module, connection_header)
# Convenience variables
state = module.params.get('state')
name = module.params.get('name')
display_name = module.params.get('display_name')
icon_uri = module.params.get('icon_uri')
client_id = module.params.get('client_id')
realm = module.params.get('realm')
state = module.params.get("state")
name = module.params.get("name")
display_name = module.params.get("display_name")
icon_uri = module.params.get("icon_uri")
client_id = module.params.get("client_id")
realm = module.params.get("realm")
# Get the "id" of the client based on the usually more human-readable
# "clientId"
cid = kc.get_client_id(client_id, realm=realm)
if not cid:
module.fail_json(msg=f'Invalid client {client_id} for realm {realm}')
module.fail_json(msg=f"Invalid client {client_id} for realm {realm}")
# Get current state of the Authorization Scope using its name as the search
# filter. This returns False if it is not found.
before_authz_scope = kc.get_authz_authorization_scope_by_name(
name=name, client_id=cid, realm=realm)
before_authz_scope = kc.get_authz_authorization_scope_by_name(name=name, client_id=cid, realm=realm)
# Generate a JSON payload for Keycloak Admin API. This is needed for
# "create" and "update" operations.
desired_authz_scope = {}
desired_authz_scope['name'] = name
desired_authz_scope['displayName'] = display_name
desired_authz_scope['iconUri'] = icon_uri
desired_authz_scope["name"] = name
desired_authz_scope["displayName"] = display_name
desired_authz_scope["iconUri"] = icon_uri
# Add "id" to payload for modify operations
if before_authz_scope:
desired_authz_scope['id'] = before_authz_scope['id']
desired_authz_scope["id"] = before_authz_scope["id"]
# Ensure that undefined (null) optional parameters are presented as empty
# strings in the desired state. This makes comparisons with current state
# much easier.
for k, v in desired_authz_scope.items():
if not v:
desired_authz_scope[k] = ''
desired_authz_scope[k] = ""
# Do the above for the current state
if before_authz_scope:
for k in ['displayName', 'iconUri']:
for k in ["displayName", "iconUri"]:
if k not in before_authz_scope:
before_authz_scope[k] = ''
before_authz_scope[k] = ""
if before_authz_scope and state == 'present':
if before_authz_scope and state == "present":
changes = False
for k, v in desired_authz_scope.items():
if before_authz_scope[k] != v:
@ -220,56 +224,57 @@ def main():
if changes:
if module._diff:
result['diff'] = dict(before=before_authz_scope, after=desired_authz_scope)
result["diff"] = dict(before=before_authz_scope, after=desired_authz_scope)
if module.check_mode:
result['changed'] = True
result['msg'] = 'Authorization scope would be updated'
result["changed"] = True
result["msg"] = "Authorization scope would be updated"
module.exit_json(**result)
else:
kc.update_authz_authorization_scope(
payload=desired_authz_scope, id=before_authz_scope['id'], client_id=cid, realm=realm)
result['changed'] = True
result['msg'] = 'Authorization scope updated'
payload=desired_authz_scope, id=before_authz_scope["id"], client_id=cid, realm=realm
)
result["changed"] = True
result["msg"] = "Authorization scope updated"
else:
result['changed'] = False
result['msg'] = 'Authorization scope not updated'
result["changed"] = False
result["msg"] = "Authorization scope not updated"
result['end_state'] = desired_authz_scope
elif not before_authz_scope and state == 'present':
result["end_state"] = desired_authz_scope
elif not before_authz_scope and state == "present":
if module._diff:
result['diff'] = dict(before={}, after=desired_authz_scope)
result["diff"] = dict(before={}, after=desired_authz_scope)
if module.check_mode:
result['changed'] = True
result['msg'] = 'Authorization scope would be created'
result["changed"] = True
result["msg"] = "Authorization scope would be created"
module.exit_json(**result)
else:
kc.create_authz_authorization_scope(
payload=desired_authz_scope, client_id=cid, realm=realm)
result['changed'] = True
result['msg'] = 'Authorization scope created'
result['end_state'] = desired_authz_scope
elif before_authz_scope and state == 'absent':
kc.create_authz_authorization_scope(payload=desired_authz_scope, client_id=cid, realm=realm)
result["changed"] = True
result["msg"] = "Authorization scope created"
result["end_state"] = desired_authz_scope
elif before_authz_scope and state == "absent":
if module._diff:
result['diff'] = dict(before=before_authz_scope, after={})
result["diff"] = dict(before=before_authz_scope, after={})
if module.check_mode:
result['changed'] = True
result['msg'] = 'Authorization scope would be removed'
result["changed"] = True
result["msg"] = "Authorization scope would be removed"
module.exit_json(**result)
else:
kc.remove_authz_authorization_scope(
id=before_authz_scope['id'], client_id=cid, realm=realm)
result['changed'] = True
result['msg'] = 'Authorization scope removed'
elif not before_authz_scope and state == 'absent':
result['changed'] = False
kc.remove_authz_authorization_scope(id=before_authz_scope["id"], client_id=cid, realm=realm)
result["changed"] = True
result["msg"] = "Authorization scope removed"
elif not before_authz_scope and state == "absent":
result["changed"] = False
else:
module.fail_json(msg=f'Unable to determine what to do with authorization scope {name} of client {client_id} in realm {realm}')
module.fail_json(
msg=f"Unable to determine what to do with authorization scope {name} of client {client_id} in realm {realm}"
)
module.exit_json(**result)
if __name__ == '__main__':
if __name__ == "__main__":
main()