Versão 4.0.23.2
Observação: estes documentos são referentes a uma versão mais antiga da API. A referência da API também está disponível para
a versão mais recente, 4.0.23.6
.
Consiga a configuração do OIDC.
O Looker pode ser configurado opcionalmente para autenticar usuários em um servidor de autenticação OpenID Connect (OIDC). A configuração do OIDC requer coordenação com um administrador do servidor.
Somente administradores do Looker podem ler e atualizar a configuração do OIDC.
A configuração do OIDC afeta a autenticação de todos os usuários. Essa configuração deve ser feita com cuidado.
O Looker mantém uma única configuração do OIDC. Ele pode ser lido e atualizado. As atualizações só serão bem-sucedidas se o novo estado for válido (no sentido de que todos os campos obrigatórios são preenchidos). Cabe a você garantir que a configuração seja adequada e esteja correta.
O OIDC é ativado ou desativado para o Looker usando o campo ativado .
Solicitação
GET
/oidc_config
Resposta
200: configuração do OIDC.
pode
lock
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.
público-alvo
string
Público-alvo do provedor OpenID
Atributo auth_requires_role
booleano
Os usuários não poderão fazer login, a menos que uma função seja encontrada no OIDC se definida como verdadeira
autorização_endpoint
string
URL de autorização do provedor OpenID
default_new_user_group_ids
string[]
grupos_novos_usuários_padrão
Expandir definição do grupo...
pode
lock
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
lock
booleano
O usuário conectado atualmente é membro do grupo
ID_grupo_externo
lock
string
Grupo de código externo se o grupo incorporado
externamente_gerenciado
lock
booleano
Associação a grupos controlada fora do Looker
id
lock
string
ID exclusivo
incluir_por_padrão
lock
booleano
Os novos usuários são adicionados a este grupo por padrão
nome
string
Nome do grupo
contagem_de_usuários
lock
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
lock
objeto
Operações que o usuário atual pode realizar neste objeto
id
lock
string
ID exclusivo
nome
string
Nome da função
permissão_definido
lock
(Somente leitura) Conjunto de permissões
Expandir a definição de PermissionSet...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
Acesso ilimitado
lock
booleano
id
lock
string
ID exclusivo
nome
string
Nome do PermissionSet
url
lock
string
Link para obter este item
ID_permissão_conjunto
string
(Somente gravação) ID do conjunto de permissões
set_model
lock
(Somente leitura) Conjunto de modelos
Expandir definição do ModelSet...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
Acesso ilimitado
lock
booleano
id
lock
string
ID exclusivo
nome
string
Nome do ModelSet
url
lock
string
Link para obter este item
ID_conjunto_do_modelo
string
(Somente gravação) ID do conjunto de modelos
url
lock
string
Link para obter este item
url_de_usuários
lock
string
Link para ver a lista de usuários com essa função
ativado
booleano
Ativar/desativar a autenticação OIDC para o servidor
Expandir a definição do OIDCGroupRead...
id
lock
string
ID exclusivo
código_do_grupo_de_pesquisadores
lock
string
ID exclusivo do grupo no Looker
nome_do_grupo_de_pesquisadores
lock
string
Nome do grupo no Looker
nome
lock
string
Nome do grupo no OIDC
Expandir definição do papel...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
id
lock
string
ID exclusivo
nome
string
Nome da função
permissão_definido
lock
(Somente leitura) Conjunto de permissões
ID_permissão_conjunto
string
(Somente gravação) ID do conjunto de permissões
set_model
lock
(Somente leitura) Conjunto de modelos
ID_conjunto_do_modelo
string
(Somente gravação) ID do conjunto de modelos
url
lock
string
Link para obter este item
url_de_usuários
lock
string
Link para ver a lista de usuários com essa função
Atributo "groups_"
string
Nome dos atributos de registro do usuário usados para indicar grupos. Usado quando "groups_finder_type" é definido como "values_attribute_values"
Expandir a definição do OIDCGroupWrite...
código_do_grupo_de_pesquisadores
lock
string
ID exclusivo do grupo no Looker
nome_do_grupo_de_pesquisadores
string
Nome do grupo no Looker
nome
string
Nome do grupo no OIDC
identificador
string
Identificador de terceira parte confiável (fornecido pelo provedor OpenID)
issuer
string
Emissor de provedor de OpenID
modificado em
lock
string
Quando a configuração foi modificada pela última vez
modificado_por
lock
string
ID do usuário que modificou esta configuração pela última vez
new_user_migration_types
string
Mescle o login pela primeira vez com uma conta de usuário existente com endereços de e-mail. Quando um usuário faz login pela primeira vez via oidc, essa opção conecta esse usuário à conta existente encontrando a conta com um endereço de e-mail correspondente testando os tipos de credenciais fornecidos para os usuários existentes. Caso contrário, uma nova conta será criada para o usuário. Essa lista (se fornecida) precisa ser uma lista de strings separada por vírgulas, como "email,ldap,google"
secret
string
(Somente gravação) Segredo da parte confiável (fornecido pelo provedor OpenID)
definir_papéis_de_grupos
booleano
Definir funções de usuários no Looker com base em grupos do OIDC
slug_test
lock
string
Slug para identificar configurações criadas para executar um teste de configuração do OIDC
token_endpoint
string
URL do token do provedor de OpenID
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
Expandir a definição do OIDCUserAttributeRead...
nome
lock
string
Nome do atributo de usuário no OIDC
obrigatório
lock
booleano
Necessário estar na declaração do OIDC para permitir o login
Expandir definição do UserAttribute...
pode
lock
objeto
Operações que o usuário atual pode realizar neste objeto
id
lock
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
lock
booleano
O atributo é um padrão do sistema
is_permanente
lock
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.
Expandir a definição do OIDCUserAttributeWrite...
nome
string
Nome do atributo de usuário no OIDC
obrigatório
booleano
Necessário estar na declaração do OIDC para permitir o login
ids_do_atributo_do_usuário
string[]
Userinfo_endpoint
string
URL de informações do usuário do provedor de OpenID
allow_normal_group_membership
booleano
Permitir que os usuários autenticados do OIDC sejam membros de grupos não refletidos do Looker. Se for "false", o usuário será removido do grupo não refletido no login.
allow_roles_from_normal_groups
booleano
Os usuários com autenticação OIDC herdarão papéis de grupos não refletidos do Looker.
funções_permitir_diretos
booleano
Permite que os papéis sejam atribuídos diretamente aos usuários autenticados do OIDC.
url
lock
string
Link para obter este item
403: permissão negada
mensagem
lock
string
Detalhes do erro
url_da_documentação
lock
string
Link da documentação
404: não encontrado
mensagem
lock
string
Detalhes do erro
url_da_documentação
lock
string
Link da documentação