Atualizar configuração LDAP

Versão 4.0.23.2

Atualize a configuração LDAP.

A configuração do LDAP afeta a autenticação de todos os usuários. Essa configuração deve ser feita com cuidado.

Somente administradores do Looker podem ler e atualizar a configuração LDAP.

O LDAP está ativado ou desativado para o Looker usando o campo ativado.

É altamente recomendável testar todas as alterações na configuração LDAP usando as APIs abaixo antes de elas serem definidas globalmente.

Consulte os documentos LDAP do Looker para mais informações.

Solicitação

PATCH /ldap_config
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
LDAPConfig (em inglês)
Configuração LDAP
Expandir definição LDAPConfig...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
e-mail_alternativo_e-mail_permitido
booleano
Permitir login alternativo com base em e-mail via "/login/email" para administradores e usuários especificados com a permissão "login_special_email". Essa opção é útil como fallback durante a configuração do LDAP, se ocorrerem problemas de configuração do LDAP ou se você precisar oferecer suporte a alguns usuários que não estão no seu diretório LDAP. Os logins por e-mail/senha do Looker são sempre desativados para usuários comuns quando o LDAP está ativado.
auth_password
string
Senha (somente gravação) da conta LDAP usada para acessar o servidor LDAP
Atributo auth_requires_role
booleano
Os usuários não poderão fazer login, a menos que uma função seja encontrada no LDAP se definida como "Verdadeira"
nome_de_usuário_autenticação
string
Nome distinto da conta LDAP usada para acessar o servidor LDAP
host_de_conexão
string
Nome do host do servidor LDAP
porta_de_conexão
string
Porta do host LDAP
conexão_tls
booleano
Usar o Transport Layer Security
conexão_tls_no_verify
booleano
Não verificar o par ao usar TLS
default_new_user_group_ids
string[]
grupos_novos_usuários_padrão
Grupo[]
default_new_user_role_ids
string[]
papéis_novo_usuário_padrão
ativado
booleano
Ativar/desativar a autenticação LDAP para o servidor
forçar_não_página
booleano
Não tente fazer paginação de resultados de pesquisa LDAP (RFC 2696), mesmo que o servidor LDAP afirme sua compatibilidade.
grupos
base_grupo_dn
string
Dn de base para encontrar grupos em pesquisas LDAP
tipo_localizador_de_grupos
string
Identificador de uma estratégia para pesquisar grupos no Looker no Looker
atributo_membro_do_grupo
string
Atributo do grupo LDAP que indica os membros dos grupos. Geralmente "membro"
groups_objectclasses
string
Lista opcional separada por vírgulas de classe de objeto LDAP compatível para grupos ao fazer pesquisas de grupos
Atributo "user_groups"
string
Atributo do grupo LDAP que representa o usuário em um grupo. Geralmente, "dn"
groups_with_role_ids
has_auth_password
booleano
(Somente leitura) A senha foi definida para a conta LDAP usada para acessar o servidor LDAP
mesclar_novos_usuários_por_e-mail
booleano
Mescle o login LDAP pela primeira vez com a conta de usuário existente por endereço de e-mail. Quando um usuário faz login pela primeira vez via ldap, essa opção conecta o usuário à conta existente encontrando a conta com um endereço de e-mail correspondente. Caso contrário, uma nova conta será criada para o usuário.
modificado em
string
Quando a configuração foi modificada pela última vez
modificado_por
string
ID do usuário que modificou esta configuração pela última vez
definir_papéis_de_grupos
booleano
Definir funções de usuários no Looker com base em grupos do LDAP
senha_de_LDAP_test
string
(Somente gravação) Testar a senha do usuário LDAP. Apenas para testes ldap.
teste_ldap_user
string
(Somente gravação) Teste o código de login do usuário LDAP. Apenas para testes ldap.
email_atributo_do_mapa_do_usuário
string
Nome dos atributos de registro do usuário usados para indicar o campo de endereço de e-mail
user_attribute_map_first_name
string
Nome dos atributos de registro do usuário usados para indicar o nome
user_attribute_map_last_name
string
Nome dos atributos de registro do usuário usados para indicar o sobrenome
usuario_atributo_mapa_ldap_id
string
Nome dos atributos de registro do usuário usados para indicar o código de registro exclusivo
Atributos do usuário
user_attributes_with_ids
user_bind_base_dn
string
Nome distinto do nó LDAP usado como base para as pesquisas do usuário
filtro_personalizado_do_usuário
string
(Opcional) Cláusula de filtro personalizada RFC-2254 a ser usada na localização do usuário durante o login. Combinado via "and" com as outras cláusulas de filtro geradas.
nome_do_atributo_do_usuário
string
Nomes dos atributos de registro de usuário usados para correspondência do ID de login do usuário (lista separada por vírgulas)
user_objectclass
string
(Opcional) Nome da classe de objeto de registro do usuário usada para localizar o usuário durante o ID de login
allow_normal_group_membership
booleano
Permitir que os usuários autenticados do LDAP sejam membros de grupos do Looker não refletidos. Se for "false", o usuário será removido do grupo não refletido no login.
allow_roles_from_normal_groups
booleano
Os usuários autenticados pelo LDAP poderão herdar papéis de grupos não refletidos do Looker.
funções_permitir_diretos
booleano
Permite que as funções sejam atribuídas diretamente aos usuários autenticados do LDAP.
url
string
Link para obter este item

Resposta

200: novo estado da configuração LDAP.

Tipo de dados
Descrição
(objeto)
LDAPConfig (em inglês)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
e-mail_alternativo_e-mail_permitido
booleano
Permitir login alternativo com base em e-mail via "/login/email" para administradores e usuários especificados com a permissão "login_special_email". Essa opção é útil como fallback durante a configuração do LDAP, se ocorrerem problemas de configuração do LDAP ou se você precisar oferecer suporte a alguns usuários que não estão no seu diretório LDAP. Os logins por e-mail/senha do Looker são sempre desativados para usuários comuns quando o LDAP está ativado.
auth_password
string
Senha (somente gravação) da conta LDAP usada para acessar o servidor LDAP
Atributo auth_requires_role
booleano
Os usuários não poderão fazer login, a menos que uma função seja encontrada no LDAP se definida como "Verdadeira"
nome_de_usuário_autenticação
string
Nome distinto da conta LDAP usada para acessar o servidor LDAP
host_de_conexão
string
Nome do host do servidor LDAP
porta_de_conexão
string
Porta do host LDAP
conexão_tls
booleano
Usar o Transport Layer Security
conexão_tls_no_verify
booleano
Não verificar o par ao usar TLS
default_new_user_group_ids
string[]
grupos_novos_usuários_padrão
Grupo[]
Expandir definição do grupo...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
can_add_to_content_metadata
booleano
O grupo pode ser usado nos controles de acesso ao conteúdo
contains_current_user
booleano
O usuário conectado atualmente é membro do grupo
ID_grupo_externo
string
Grupo de código externo se o grupo incorporado
externamente_gerenciado
booleano
Associação a grupos controlada fora do Looker
id
string
ID exclusivo
incluir_por_padrão
booleano
Os novos usuários são adicionados a este grupo por padrão
nome
string
Nome do grupo
contagem_de_usuários
integer
Número de usuários incluídos neste grupo
default_new_user_role_ids
string[]
papéis_novo_usuário_padrão
Expandir definição do papel...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
nome
string
Nome da função
permissão_definido
(Somente leitura) Conjunto de permissões
Expandir a definição de PermissionSet...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
Acesso ilimitado
booleano
integrado
booleano
id
string
ID exclusivo
nome
string
Nome do PermissionSet
permissões
string[]
url
string
Link para obter este item
ID_permissão_conjunto
string
(Somente gravação) ID do conjunto de permissões
set_model
(Somente leitura) Conjunto de modelos
Expandir definição do ModelSet...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
Acesso ilimitado
booleano
integrado
booleano
id
string
ID exclusivo
modelos
string[]
nome
string
Nome do ModelSet
url
string
Link para obter este item
ID_conjunto_do_modelo
string
(Somente gravação) ID do conjunto de modelos
url
string
Link para obter este item
url_de_usuários
string
Link para ver a lista de usuários com essa função
ativado
booleano
Ativar/desativar a autenticação LDAP para o servidor
forçar_não_página
booleano
Não tente fazer paginação de resultados de pesquisa LDAP (RFC 2696), mesmo que o servidor LDAP afirme sua compatibilidade.
grupos
Expandir a definição do LDAPGroupRead...
id
string
ID exclusivo
código_do_grupo_de_pesquisadores
string
ID exclusivo do grupo no Looker
nome_do_grupo_de_pesquisadores
string
Nome do grupo no Looker
nome
string
Nome do grupo no LDAP
papéis
Expandir definição do papel...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
nome
string
Nome da função
permissão_definido
(Somente leitura) Conjunto de permissões
ID_permissão_conjunto
string
(Somente gravação) ID do conjunto de permissões
set_model
(Somente leitura) Conjunto de modelos
ID_conjunto_do_modelo
string
(Somente gravação) ID do conjunto de modelos
url
string
Link para obter este item
url_de_usuários
string
Link para ver a lista de usuários com essa função
url
string
Link para a configuração do LDAP
base_grupo_dn
string
Dn de base para encontrar grupos em pesquisas LDAP
tipo_localizador_de_grupos
string
Identificador de uma estratégia para pesquisar grupos no Looker no Looker
atributo_membro_do_grupo
string
Atributo do grupo LDAP que indica os membros dos grupos. Geralmente "membro"
groups_objectclasses
string
Lista opcional separada por vírgulas de classe de objeto LDAP compatível para grupos ao fazer pesquisas de grupos
Atributo "user_groups"
string
Atributo do grupo LDAP que representa o usuário em um grupo. Geralmente, "dn"
groups_with_role_ids
Expandir a definição de LDAPGroupWrite...
id
string
ID exclusivo
código_do_grupo_de_pesquisadores
string
ID exclusivo do grupo no Looker
nome_do_grupo_de_pesquisadores
string
Nome do grupo no Looker
nome
string
Nome do grupo no LDAP
IDs_do_papel
string[]
url
string
Link para a configuração do LDAP
has_auth_password
booleano
(Somente leitura) A senha foi definida para a conta LDAP usada para acessar o servidor LDAP
mesclar_novos_usuários_por_e-mail
booleano
Mescle o login LDAP pela primeira vez com a conta de usuário existente por endereço de e-mail. Quando um usuário faz login pela primeira vez via ldap, essa opção conecta o usuário à conta existente encontrando a conta com um endereço de e-mail correspondente. Caso contrário, uma nova conta será criada para o usuário.
modificado em
string
Quando a configuração foi modificada pela última vez
modificado_por
string
ID do usuário que modificou esta configuração pela última vez
definir_papéis_de_grupos
booleano
Definir funções de usuários no Looker com base em grupos do LDAP
senha_de_LDAP_test
string
(Somente gravação) Testar a senha do usuário LDAP. Apenas para testes ldap.
teste_ldap_user
string
(Somente gravação) Teste o código de login do usuário LDAP. Apenas para testes ldap.
email_atributo_do_mapa_do_usuário
string
Nome dos atributos de registro do usuário usados para indicar o campo de endereço de e-mail
user_attribute_map_first_name
string
Nome dos atributos de registro do usuário usados para indicar o nome
user_attribute_map_last_name
string
Nome dos atributos de registro do usuário usados para indicar o sobrenome
usuario_atributo_mapa_ldap_id
string
Nome dos atributos de registro do usuário usados para indicar o código de registro exclusivo
Atributos do usuário
Expandir definição LDAPUserAttributeRead...
nome
string
Nome do atributo do usuário no LDAP
obrigatório
booleano
Necessário estar na declaração LDAP para que o login seja bem-sucedido
Atributos do usuário
Expandir definição do UserAttribute...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID exclusivo
nome
string
Nome do atributo do usuário
Rótulo
string
Rótulo humano para o atributo do usuário
tipo
string
Tipo de atributo de usuário ("string", "number", "datetime", "yesno", "zipcode")
default_value
string
Valor padrão quando nenhum valor é definido no usuário
sistema_is
booleano
O atributo é um padrão do sistema
is_permanente
booleano
O atributo é permanente e não pode ser excluído
valor_é_oculto
booleano
Se verdadeiro, os usuários não poderão ver os valores deste atributo.
user_can_view
booleano
Os usuários que não são administradores podem ver os valores dos atributos e usá-los em filtros.
user_can_edit
booleano
Os usuários podem alterar o valor desse atributo por conta própria
valor_do_domínio_oculto
string
Destinos para os quais um atributo oculto pode ser enviado. Uma vez definido, não pode ser editado.
url
string
Link para a configuração do LDAP
user_attributes_with_ids
Expandir definição LDAPUserAttributeWrite...
nome
string
Nome do atributo do usuário no LDAP
obrigatório
booleano
Necessário estar na declaração LDAP para que o login seja bem-sucedido
ids_do_atributo_do_usuário
string[]
url
string
Link para a configuração do LDAP
user_bind_base_dn
string
Nome distinto do nó LDAP usado como base para as pesquisas do usuário
filtro_personalizado_do_usuário
string
(Opcional) Cláusula de filtro personalizada RFC-2254 a ser usada na localização do usuário durante o login. Combinado via "and" com as outras cláusulas de filtro geradas.
nome_do_atributo_do_usuário
string
Nomes dos atributos de registro de usuário usados para correspondência do ID de login do usuário (lista separada por vírgulas)
user_objectclass
string
(Opcional) Nome da classe de objeto de registro do usuário usada para localizar o usuário durante o ID de login
allow_normal_group_membership
booleano
Permitir que os usuários autenticados do LDAP sejam membros de grupos do Looker não refletidos. Se for "false", o usuário será removido do grupo não refletido no login.
allow_roles_from_normal_groups
booleano
Os usuários autenticados pelo LDAP poderão herdar papéis de grupos não refletidos do Looker.
funções_permitir_diretos
booleano
Permite que as funções sejam atribuídas diretamente aos usuários autenticados do LDAP.
url
string
Link para obter este item

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

403: permissão negada

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação