�
�Udac @` s� d d l m Z m Z m Z e Z i d d 6d g d 6d d 6Z d Z d Z d
Z d d l
m Z m Z m
Z
m Z m Z d d l m Z d
� Z e d k r� e � n d S( i ( t absolute_importt divisiont print_functions 1.1t metadata_versiont previewt statust communityt supported_bys�
---
module: keycloak_group
short_description: Allows administration of Keycloak groups via Keycloak API
description:
- This module allows you to add, remove or modify Keycloak groups via the Keycloak REST API.
It requires access to the REST API via 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(http://www.keycloak.org/docs-api/3.3/rest-api/).
- 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.
- When updating a group, where possible provide the group ID to the module. This removes a lookup
to the API to translate the name into the group ID.
version_added: "2.8"
options:
state:
description:
- State of the group.
- On C(present), the group will be created if it does not yet exist, or updated with the parameters you provide.
- On C(absent), the group will be removed if it exists.
required: true
default: 'present'
type: str
choices:
- present
- absent
name:
type: str
description:
- Name of the group.
- This parameter is required only when creating or updating the group.
realm:
type: str
description:
- They Keycloak realm under which this group resides.
default: 'master'
id:
type: str
description:
- The unique identifier for this group.
- This parameter is not required for updating or deleting a group but
providing it will reduce the number of API calls required.
attributes:
type: dict
description:
- A dict of key/value pairs to set as custom attributes for the group.
- Values may be single values (e.g. a string) or a list of strings.
notes:
- Presently, the I(realmRoles), I(clientRoles) and I(access) attributes returned by the Keycloak API
are read-only for groups. This limitation will be removed in a later version of this module.
extends_documentation_fragment:
- keycloak
author:
- Adam Goossens (@adamgoossens)
s�
- name: Create a Keycloak group
keycloak_group:
name: my-new-kc-group
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: Delete a keycloak group
keycloak_group:
id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
state: absent
realm: MyCustomRealm
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 group based on name
keycloak_group:
name: my-group-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: Update the name of a Keycloak group
keycloak_group:
id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
name: an-updated-kc-group-name
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 group with some custom attributes
keycloak_group:
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_group
attributes:
attrib1: value1
attrib2: value2
attrib3:
- with
- numerous
- individual
- list
- items
delegate_to: localhost
s�
group:
description: Group representation of the group after module execution (sample is truncated).
returned: always
type: complex
contains:
id:
description: GUID that identifies the group
type: str
returned: always
sample: 23f38145-3195-462c-97e7-97041ccea73e
name:
description: Name of the group
type: str
returned: always
sample: grp-test-123
attributes:
description: Attributes applied to this group
type: dict
returned: always
sample:
attr1: ["val1", "val2", "val3"]
path:
description: URI path to the group
type: str
returned: always
sample: /grp-test-123
realmRoles:
description: An array of the realm-level roles granted to this group
type: list
returned: always
sample: []
subGroups:
description: A list of groups that are children of this group. These groups will have the same parameters as
documented here.
type: list
returned: always
clientRoles:
description: A list of client-level roles granted to this group
type: list
returned: always
sample: []
access:
description: A dict describing the accesses you have to this group based on the credentials used.
type: dict
returned: always
sample:
manage: true
manageMembership: true
view: true
( t KeycloakAPIt camelt keycloak_argument_spect get_tokent
KeycloakError( t
AnsibleModulec C` s? t � } t d t d d d d d g � d t d d � d t d d
� d t d d
� d t d d
� � } | j | � t d | d t d d d g g � } t d t d d d i d d � } y� t d | j j d � d | j j d � d | j j d � d | j j d � d | j j d � d | j j d � d | j j d � � } Wn) t k
rq} | j
d t | � � n Xt | | � } | j j d � } | j j d � } | j j d � } | j j d � }
| j j d � } d) } | d) k r| j |
d | �} n | j | d | �} | d) k r,i n | } | d) k r�xM | j d j � D]5 \ }
} t | t � sv| g n | | j d |
<qRWn g | j D]I } | t t � j � � d d g k r�| j j | � d) k r�| ^ q�} i } x[ | D]S } | j j | � } | | k r"| | n d) } | | k r�| | t | � <q�q�W| j � } | j | � | i k r�| d k r�| j r�t d d d! d � | d <n d" | d <t � | d <| j | � n t | d <|
d) k r�| j
d d# � n | j rt d d d! | � | d <n | j r/| j | � n | j | d | �| j |
| � } | | d <d$ j d | d d | d � | d <n�| d k r�| | k r�t | d <| | d <d% j d | d � | d <| j | � n t | d <| j r
t d | d! | � | d <n | j r#| j | � n | j | d | �| j | d d | �} | | d <d& j d | d � | d <| j | � n� | d k r.t � | d <| j r�t d | d! d � | d <n | j r�| j | � n | d } | j d' | d | � t | d <d( j d | d � | d <| j | � n | j | � d) S(* s(
Module execution
:return:
t statet defaultt presentt choicest absentt realmt mastert idt typet strt namet
attributest dictt
argument_spect supports_check_modet required_one_oft changedt msgt t difft groupt base_urlt auth_keycloak_urlt validate_certst
auth_realmt client_idt auth_client_idt
auth_usernamet
auth_passwordt
client_secrett auth_client_secrett beforet afters$ Group does not exist; doing nothing.s0 name must be specified when creating a new groups* Group {name} has been created with ID {id}s$ No changes required to group {name}.s Group {id} has been updatedt groupids Group {name} has been deletedN( R
R t updateR
t Truet FalseR t paramst getR t fail_jsonR R t Nonet get_group_by_namet get_group_by_groupidt itemst
isinstancet listt keysR t copyt _difft exit_jsont
check_modet create_groupt formatt update_groupt delete_group( R t meta_argst modulet resultt connection_headert et kcR R t gidR R t before_groupt keyt valt xt group_paramst changesett paramt new_param_valuet old_valuet
updated_groupt after_group( ( sT /usr/lib/python2.7/site-packages/ansible/modules/identity/keycloak/keycloak_group.pyt main� s�
! 0%$
t __main__N( t
__future__R R R R t
__metaclass__t ANSIBLE_METADATAt
DOCUMENTATIONt EXAMPLESt RETURNt/ ansible.module_utils.identity.keycloak.keycloakR R R
R R t ansible.module_utils.basicR
RW t __name__( ( ( sT /usr/lib/python2.7/site-packages/ansible/modules/identity/keycloak/keycloak_group.pyt <module> s
KD4( �
Anons79 File Manager Version 1.0, Coded By Anons79
Email: [email protected]
Anons79 Mini Shell