Keycloak Role
Resumo
- Este módulo cria, remove ou atualiza a função de nível de domínio Keycloak.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
attributes | dictionary | | Lista os atributos. |
clientRole | boolean | Escolhas: - false (default) - true | Este parâmetro indica se a role é uma client role. Para uma role de domínio, esse parâmetro deve ser falso. |
composite | boolean | Escolhas: - false (default) - true | Se verdadeiro, a role é uma composição de outro domínio e/ou client role. |
composites | list | | Lista de roles a serem incluídas na role de domínio composto. Se a função composta for uma client role, o clientId (não o id do cliente) deve ser especificado. |
containerId | string | | Id do contêiner da role. Para uma role de domínio, deve ser o nome do domínio. O valor será padronizado para {{realm}} se não for definido. |
description | string | | Descrição da role. |
name | string | | Name for the realm level role. |
realm | string | - master (default) | The name of the realm in which is the role. |
state | string | Escolhas: - present (default) - absent | Se definido como present, dependendo da utilização, poderá criar ou atualizar o usuário. Se definido como absent, o usuário será excluído (cuidado). |
force: | boolean | Escolhas: - false (default) - true | Se definido como true, força a exclusão da role e recria outra (cuidado). |
Subcampos da opção composites
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
name - required | string | | Nome da role. Pode ser o nome de uma realmRole ou de clientRole. |
clientId | string | | ID do client se a função for uma clientRole. Não inclua esta opção para uma realmRole. Use a id do client que podemos ver no console do Keycloak, não a id técnica. |
Exemplos
# Exemplo: Crie a função de domínio composto role1 com roles compostas.
keycloak_role:
auth_keycloak_url: http://localhost:8080/auth
auth_username: admin
auth_password: password
auth_realm: master
name: role1
description: Super composite role
composite: true
composites:
- clientId: realm-management
name: "manage-clients"
- name: uma_authorization
state: present
# Exemplo: Re-create realm role role1
keycloak_role:
auth_keycloak_url: http://localhost:8080/auth
auth_username: admin
auth_password: password
auth_realm: master
name: role1
description: Super composite role
composite: true
composites:
- clientId: realm-management
name: "manage-clients"
- name: uma_authorization
state: present
force: yes
# Exemplo: Remove realm role role1.
keycloak_role:
auth_keycloak_url: http://localhost:8080/auth
auth_username: admin
auth_password: password
auth_realm: master
name: role1
state: absent
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
role | dictionary | Sucesso | Representação JSON para a função. |
composites | list | Sucesso | Representação JSON de composições para a função. |
msg | string | Error | Mensagem de erro se for o caso |
changed | boolean | Sempre | Retorna True se a operação mudou a função no servidor keycloak, caso contrário, false. |