Keycloak Search User
Resumo
Procura usuários no realm.
Parâmetros
Extende a documentação do módulo keycloak_auth_options
Parâmetros | Tipo | Escolha | Valor Padrão | Comentários |
|---|---|---|---|
query | dict | | Opções para procurar usuários |
Subcampos da opção query
Parâmetros | Tipo | Escolha | Valor Padrão | Comentários |
|---|---|---|---|
briefRepresentation | bool | default: true | Restringe as opções retornadas |
str | | Procura email fornecido nos usuários cadastrados | |
emailVerified | bool | | Limita busca a usuários com email verificados |
enabled | bool | | Limita busca a usuários habilitados |
exact | bool | | Limita busca via email, first/last name e username a ocorrências exatadas |
first | int | | Primeiro elemento da paginação |
firstName | str | | Procura usuário pelo primero nome |
idpAlias | str | | Procura pelo Identity Provider do usuário |
idpUserId | str | | Procura pelo id fornecido pelo Identity Provider vinculado ao usuário |
lastName | str | | Procura usuário pelo sobrenome fornecido |
max | int | | Limita o tamanho do resultado na paginação |
search | str | | Procura o usuário no first/last name, email e username |
username | str | | Procura o usuário pelo username fornecido |
Valores Retornados
Parâmetros | Tipo | Escolha | Valor Padrão | Comentários |
|---|---|---|---|
error | bool | | Se ouve algum error durante a autenticação |
msg | str | | Mensagens de erro, se houver |
user_list | list | | Retorna uma lista de usuários(dicionários) |
Subcampos da opção user_list
Parâmetros | Tipo | Escolha | Valor Padrão | Comentários |
|---|---|---|---|
id | str | | User UUID |
createdTimestamp | str | | Timestamp da criação do usuário (UNIX) |
username | str | | |
enabled | bool | | Se o usuário está habilitado |
totp | bool | | Se TOTP está habilitado para o usuário |
emailVerified | bool | | Se o email do usuário é verificado |
disableableCredentialsTypes | list | | |
requiredActions | list[str] | update_user_locale CONFIGURE_TOTP VERIFY_EMAIL UPDATE_PASSWORD UPDATE_PROFILE | Ações que o usuário deve realizar quando fizer login |
notBefore | int | | |
access | dict | | |
Subcampos da opção access
Parâmetros | Tipo | Escolha | Valor Padrão | Comentários |
|---|---|---|---|
manageGroupMembership | bool | | |
view | bool | | |
mapRoles | bool | | |
impersonate | bool | | Se o usuário pode ser personificado |
manage | bool | | |