Atualizar configuração do OIDC

Versão 4.0.23.6 (mais recente)

Atualize 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.

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

O OIDC é ativado ou desativado para o Looker usando o campo ativado.

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

Solicitação

PATCH /oidc_config
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
OIDCConfig (em inglês)
Configuração do OIDC
Expandir a definição do OIDCConfig...
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.
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
Grupo[]
default_new_user_role_ids
string[]
papéis_novo_usuário_padrão
ativado
booleano
Ativar/desativar a autenticação OIDC para o servidor
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"
groups_with_role_ids
identificador
string
Identificador de terceira parte confiável (fornecido pelo provedor OpenID)
issuer
string
Emissor de provedor de OpenID
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
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"
scopes
string[]
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
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
Atributos do usuário
user_attributes_with_ids
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
string
Link para obter este item

Resposta

200: novo estado da configuração do OIDC.

Tipo de dados
Descrição
(objeto)
OIDCConfig (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.
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
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 OIDC para o servidor
Expandir a definição do OIDCGroupRead...
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 OIDC
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
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"
groups_with_role_ids
Expandir a definição do OIDCGroupWrite...
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 OIDC
IDs_do_papel
string[]
identificador
string
Identificador de terceira parte confiável (fornecido pelo provedor OpenID)
issuer
string
Emissor de provedor de OpenID
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
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"
scopes
string[]
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
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
Atributos do usuário
Expandir a definição do OIDCUserAttributeRead...
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
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.
user_attributes_with_ids
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
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