VhQ9|ddlmZmZmZeZdZdZdZddl m Z m Z m Z m Z mZmZddlmZddlZdZed k(reyy) )absolute_importdivisionprint_functiona module: keycloak_role short_description: Allows administration of Keycloak roles using Keycloak API version_added: 3.4.0 description: - This module allows you to add, remove or modify Keycloak roles using the Keycloak REST API. It requires access to the REST API using OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. - The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/8.0/rest-api/index.html). - Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API. attributes: check_mode: support: full diff_mode: support: full action_group: version_added: 10.2.0 options: state: description: - State of the role. - On V(present), the role will be created if it does not yet exist, or updated with the parameters you provide. - On V(absent), the role will be removed if it exists. default: 'present' type: str choices: - present - absent name: type: str required: true description: - Name of the role. - This parameter is required. description: type: str description: - The role description. realm: type: str description: - The Keycloak realm under which this role resides. default: 'master' client_id: type: str description: - If the role is a client role, the client ID under which it resides. - If this parameter is absent, the role is considered a realm role. attributes: type: dict description: - A dict of key/value pairs to set as custom attributes for the role. - Values may be single values (for example a string) or a list of strings. composite: description: - If V(true), the role is a composition of other realm and/or client role. default: false type: bool version_added: 7.1.0 composites: description: - List of roles to include to the composite realm role. - If the composite role is a client role, the C(clientId) (not ID of the client) must be specified. default: [] type: list elements: dict version_added: 7.1.0 suboptions: name: description: - Name of the role. This can be the name of a REALM role or a client role. type: str required: true client_id: description: - Client ID if the role is a client role. Do not include this option for a REALM role. - Use the client ID you can see in the Keycloak console, not the technical ID of the client. type: str required: false aliases: - clientId state: description: - Create the composite if present, remove it if absent. type: str choices: - present - absent default: present extends_documentation_fragment: - community.general.keycloak - community.general.keycloak.actiongroup_keycloak - community.general.attributes author: - Laurent Paumier (@laurpaum) a - name: Create a Keycloak realm role, authentication with credentials community.general.keycloak_role: name: my-new-kc-role 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: Create a Keycloak realm role, authentication with token community.general.keycloak_role: name: my-new-kc-role realm: MyCustomRealm state: present auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com/auth token: TOKEN delegate_to: localhost - name: Create a Keycloak client role community.general.keycloak_role: name: my-new-kc-role realm: MyCustomRealm client_id: MyClient 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: Delete a Keycloak role community.general.keycloak_role: name: my-role-for-deletion state: absent 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: Create a keycloak role with some custom attributes community.general.keycloak_role: auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com/auth auth_realm: master auth_username: USERNAME auth_password: PASSWORD name: my-new-role attributes: attrib1: value1 attrib2: value2 attrib3: - with - numerous - individual - list - items delegate_to: localhost a9 msg: description: Message as to what action was taken. returned: always type: str sample: "Role myrole has been updated" proposed: description: Representation of proposed role. returned: always type: dict sample: { "description": "My updated test description" } existing: description: Representation of existing role. returned: always type: dict sample: { "attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole" } end_state: description: Representation of role after module execution (sample is truncated). returned: on success type: dict sample: { "attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", "description": "My updated client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole" } ) KeycloakAPIcamelkeycloak_argument_spec get_token KeycloakErroris_struct_included) AnsibleModuleNcF t}ttddtddgdtddddg  }ttddddg tddtd tdd td td tdg|dtdd }|j|t|dgdggdgddi}tddiiii} t |j }t|}|j jd}|j jd} |j jd} |j jd} |j jd J|j d jD]*\} } t| ts| gn| |j d | <,|j Dcgc]G}|ttjgd!zvr|j j||I}}| |j| |}n|j!| | |}|i}i}|D]O}|j j|}||vr||nd}||k7s/t#j$||t'|<Qt#j$|}|j|||d"<||d#<|s,| dk(r=|j(rtdd$|d%<d|d&<i|d'<d(|d)<|j*d8i|d|d&<| |jd*|j(rtd|$|d%<|j,r|j*d8i|| %|j/|||j| |}n&|j1|| ||j!| | |}|d+r|j3|| |,|d-<||d'<d.j5| /|d)<|j*d8i|nC| dk(rg}d-|vrt|d-tr~t7|d-d0kDrm|j3|| |,}g|d-<|D]N}i}|d1r|j9|d2|3}|d|d<nd|d<|d|d<d|d<|d-j;|Pn|j;d-t=|||4r1d|d&<||d'<d5j5| /|d)<|j*d8i|d|d&<|j(rt||$|d%<|j,r|j*d8i|| %|j?|||j| |}n&|jA|| ||j!| | |}|d+r|j3|| |,|d-<||d'<d6j5| /|d)<|j*d8i|nd|d&<|j(rt|d$|d%<|j,r|j*d8i|| |jC| |n|jE| | |i|d'<d7j5| /|d)<|j*d8i|y#t $r&}|jt|Yd}~d}~wwxYwcc}w)9z( Module execution :return: strT)typerequiredclientIdF)raliasesrpresentabsent)rdefaultchoices)name client_idstate)rmaster)rrdictlist)rroptionselementsbool)rr descriptionrealmr attributes composites composite)token auth_realm auth_username auth_password)r&r'r( refresh_tokenr&) argument_specsupports_check_moderequired_one_ofrequired_together required_by)changedmsgdiffproposedexisting end_state)r1Nr!rrrr")rr!rr3r4)beforeafterr2r0r5z#Role does not exist, doing nothing.r1z/name must be specified when creating a new roler$)rolerepclientidr!r#zRole {name} has been created)rr clientRole containerId)idr!)excludez#No changes required to role {name}.zRole {name} has been updatedzRole {name} has been deleted)#rrupdater r paramsr fail_jsonrrgetitems isinstancerkeysget_realm_roleget_client_rolecopydeepcopyr_diff exit_json check_modecreate_realm_rolecreate_client_roleget_role_compositesformatlenget_client_by_idappendr update_realm_roleupdate_client_roledelete_realm_roledelete_client_role)r*composites_spec meta_argsmoduleresultconnection_headerekcr!r9rrkeyvalx role_params before_role changesetparamnew_param_value old_value desired_role after_rolecompare_excluder#r$before_compositecomposite_clients s/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/keycloak_role.pymainrns2 +,M ut ,EJ<%Hy9h:OPO y9h:OP ut ,e$x0E"V$VRSYZFE2 I# /3-f,g/_.`(7'F F%Rb2VX YF%%fmm4 V. /B MM  g &E}}  -H ==  V $D MM  g &E }}&2 l399; [HCK&D i '&*mmO&DIeEl # E==-L ""F:$F:  H ||!%Rr!:v %F9 "$F; AF5M F   &v &!y <   !R  S <<!<@F6N    F   &v &    u 5**47J  ! !,% @++D(EBJ k "')'='=j[ckp'='qJ| $({6==4=Hu "6" I  O|+ < ;UW[0\adeqr~ebADEbE33KRZbg3h ,. L)!+ GI')$ .+-+>+>)MBZbg+>+h(8H8T(58<(5/8/@$V,09$W- -445EF G &&|4", _U$)y!&2{# E L LRV L Wu    *6*!%F9 ||!%[ !Mv     *6*$$\59..tU; %%lHeD//hF +&+-+A+A*_got+A+u <(",F; :AAtALF5M F   &v &!%F9 ||!%[!Cv     *6*$$T51%%dHe<"$F; :AAtALF5MFvy %SV$$%$5s'Y,'A Z, Z5ZZ__main__) __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNUansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloakrrrr r r ansible.module_utils.basicr rHrn__name__r>rmrysZA@ k ZA F- ^II4 CL zFrx