Keycloak User

6 min

Resumo

Este módulo cria, remove ou atualiza usuários Keycloak.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
access	dictionary		Lista o acesso do usuário.
attributes	dictionary		Lista os atributos do usuário.
clientConsents (Possíveis valores)	list		Tipo de autenticador do cliente.
clientRoles (Possíveis valores)	list		Lista de ClientRoles para o usuário.
credentials	list		As credenciais do usuário.
disableableCredentialTypes	list		Lista o tipo de credencial do usuário.
email	string		Email do usuário.
emailVerified	boolean	Escolhas: - false (default) - true	Verifique a validade do e-mail do usuário.
enabled	boolean	Escolhas: - false - true (default)	Se o usuário será habilitado.
federatedIdentities	list		Lista de IDP do usuário.
federationLink	string		Federation Link.
firstName	string		Primeiro nome do usuário.
force	boolean	Escolhas: - false (default) - true	Se definido como true, força a exclusão do usuário e recria outro (cuidado).
groups	list		Lista com os grupos, no qual o usuário será adicionado.
id	string		ID do usuário no servidor keycloak, se conhecido.
lastName	string		Último nome do usuário.
origin	string		User origin.
realm	string	- "master" (default)	Nome do domínio no qual está o cliente.
realmRoles	list		Lista de realm roles, que serão habilitadas para o usuário.
requiredActions	list		Opção de ações requeridas.
self	string		Auto-administração do usuário.
serviceAccountClientId	string		Descrição do aplicativo cliente.
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).
username - required	string		Nome de usuário.

Subcampos da opção clientConsents

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
clientId - required	string		ID da client role.
roles - required	list		Lista de roles de cliente para atribuir ao usuário

Subcampos da opção clientRoles

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
clientId - required	string		ID da client role.
roles - required	list		Lista de roles para conceder ao usuário.

Exemplos

# Exemplo: Criar um usuário
- keycloak_user:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: admin
    auth_password: password
    auth_realm: master
    username: user1
    firstName: user1
    lastName: user1
    email: user1
    enabled: true
    emailVerified: false
    credentials:
      - type: password
        value: password
        temporary: false
    attributes:
      attr1:
        - value1
      attr2:
        - value2
    clientRoles:
      - clientId: "account"
        roles:
        - "delete-account"
      - clientId: "teste"
        roles:
        - "teste"
    groups:
      - group1
    realmRoles:
      - "create-realm"
    state: present

# Exemplo: Re-criar um usuário
- keycloak_user:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: admin
    auth_password: password
    auth_realm: master
    username: user1
    firstName: user1
    lastName: user1
    state: present
    force: true
    email: user1
    enabled: true
    emailVerified: false
    credentials:
      - type: password
        value: password
        temporary: false
    attributes:
      attr1:
        - value1
      attr2:
        - value2
    clientRoles:
      - clientId: "account"
        roles:
        - "delete-account"
      - clientId: "teste"
        roles:
        - "teste"
    groups:
      - group1
    realmRoles:
      - "create-realm"

# Exemplo: Remover usuário
- keycloak_user:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: admin
    auth_password: password
    auth_realm: master
    username: user1
    state: absent

Valores retornados

Chave	Tipo	Retornado quando	Descrição
user	dictionary	Sucesso	Representação JSON para o usuário.
msg	string	Sempre	Informa uma mensagem, se a mesma existir.
changed	boolean	Sempre	Retorna true se a operação alterou o cliente no servidor keycloak, caso contrário, false.