Keycloak Client
Resumo
- Permite a administração de clientes Keycloak via API Keycloak
- Este módulo permite a administração de clientes Keycloak através da API REST Keycloak. Requer acesso à API REST via OpenID Connect; o usuário que se conecta e o cliente que está sendo usado devem ter os direitos de acesso necessários. Em uma instalação padrão do Keycloak, admin-cli e um usuário admin funcionariam, assim como uma definição de cliente separada com o escopo feito sob medida para suas necessidades e um usuário com as funções esperadas.
- A API Keycloak nem sempre verifica a integridade das entradas, por exemplo, você pode definir configurações específicas de SAML em um cliente OpenID Connect, por exemplo, e vice-versa. Tome cuidado. Se você não especificar uma configuração, geralmente um padrão sensato é escolhido.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
state | string | Escolhas: - present (default) - absent | Estado do cliente |
realm | string | default: - master | O reino no qual criar o cliente. |
client_id aliases: clientId | string | | ID de cliente do cliente a ser trabalhado. Geralmente é um nome alfanumérico escolhido por você. É necessário esse ou o (id). Se você especificar ambos, o (id) terá precedência. |
id | string | | Id do cliente a ser trabalhado. Geralmente é um UUID. É necessário isso ou o (client_id). Se você especificar ambos, esse terá precedência. |
name | string | | Nome do cliente (não é o mesmo que o (client_id)) |
description | string | | Descrição do cliente no Keycloak |
root_url aliases: rootUrl | string | | URL raiz anexado a URLs relativos para este cliente. |
admin_url aliases: adminUrl | string | | URL para a interface administrativa do cliente Este é 'adminUrl' na API REST Keycloak. |
base_url aliases: baseUrl | string | | URL padrão a ser usado quando o servidor de autenticação precisa redirecionar ou vincular de volta ao cliente. Isso é 'baseUrl' na API REST Keycloak. |
enabled | boolean | Escolhas: - false - true | Se o cliente está habilitado ou não. |
client_authenticator_type aliases: clientAuthenticatorType | string | Escolhas: - client-secret - client-jwt | Como os clientes se autenticam no servidor de autenticação Tanto client-secret ou client-jwt podem ser escolhidos. Ao usar client-secret, o parâmetro do módulo secret pode defini-lo, enquanto para client-jwt, você pode usar as chaves use.jwks.url, jwks.url, e jwt.credential.certificate no parâmetro do módulo attributes para configurar seu comportamento. |
secret | string | | Ao usar client_authenticator_type e client-secret você pode especificar um secret aqui. Caso contrário, um será gerado se não sair. Se alterar este secret, o módulo não registrará uma alteração atualmente (mas o secret alterado será salvo). |
registration_access_token | | | O token de acesso de registro fornece acesso para clientes ao serviço de registro do cliente. Este é 'registrationAccessToken' na API REST Keycloak. |
default_roles | | | lista de funções padrão para este cliente. Se as funções do cliente referenciadas ainda não existirem, elas serão criadas. |
redirect_uris | | | |
web_origins | | | |
not_before | | | |
bearer_only | | | |
consent_required | | | |
standard_flow_enabled | | | |
implicit_flow_enabled | | | |
direct_access_grants_enabled | | | |
service_accounts_enabled | | | |
authorization_services_enabled | | | |
public_client | | | |
frontchannel_logout | | | |
protocol | | | |
full_scope_allowed | | | |
node_re_registration_timeout | | | |
registered_nodes | | | |
client_template | | | |
use_template_config | | | |
use_template_scope | | | |
use_template_mappers | | | |
surrogate_auth_required | | | |
authorization_settings | | | |
protocol_mappers | | | |
attributes | | | |
client_roles | | | |
scope_mappings | | | |
force | | | |