Atualizar configuração de SAML

Versão 3.1.23.4

Atualize a configuração de SAML.

A configuração do SAML 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 SAML.

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

É altamente recomendável que todas as alterações na configuração SAML sejam testadas usando as APIs abaixo antes de serem definidas globalmente.

Solicitação

PATCH /saml_config
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
SamlConfig (em inglês)
Configuração SAML
Expandir definição do SamlConfig...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
ativado
booleano
Ativar/desativar autenticação Saml para o servidor
cert_id
string
Certificado do provedor de identidade (fornecido pelo IdP)
URL_idp
string
URL do provedor de identidade (fornecido pelo IdP)
emissor_de_idp
string
Emissor do provedor de identidade (fornecido pelo IdP)
público-alvo do IDP
string
Público-alvo do provedor de identidade (definido na configuração do IdP). Opcional no Looker. Defina isso apenas se quiser que o Looker valide o valor do público retornado pelo IdP.
permitido_deslocamento_de_relógio
integer
Contagem de segundos de deslocamento do relógio para permitir ao validar carimbos de data/hora de declarações.
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
new_user_migration_types
string
Mescla pela primeira vez o login SAML com a conta de usuário existente por endereço de e-mail. Quando um usuário faz login pela primeira vez via saml, essa opção conecta esse usuário à conta existente dele 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"
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.
slug_test
string
Slug para identificar as configurações criadas para executar um teste de configuração do Saml
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
papéis_novo_usuário_padrão
grupos_novos_usuários_padrão
Grupo[]
default_new_user_role_ids
número inteiro[]
default_new_user_group_ids
número inteiro[]
definir_papéis_de_grupos
booleano
Definir funções de usuários no Looker com base em grupos de Samuel
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"
grupos
groups_with_role_ids
Atributo auth_requires_role
booleano
Os usuários não terão permissão para fazer login, a menos que uma função seja encontrada no Saml se ela for definida como verdadeira
Atributos do usuário
user_attributes_with_ids
tipo_localizador_de_grupos
string
Identificador de uma estratégia para o Looker encontrar grupos na resposta SAML. Um de ['grouped_attribute_values', 'individual_attributes']
valor_do_grupo_de_grupos
string
Valor do atributo de grupo usado para indicar a associação. Usado quando "groups_finder_type" é definido como "atributos individuais"
página_login_ignorado
booleano
Ignorar a página de login quando a autenticação do usuário for necessária. Em vez disso, redirecione para o IdP imediatamente.
allow_normal_group_membership
booleano
Permitir que usuários com autenticação SAML 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 por SAML herdarão 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 por SAML.
url
string
Link para obter este item

Resposta

200: novo estado da configuração SAML.

Tipo de dados
Descrição
(objeto)
SamlConfig (em inglês)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
ativado
booleano
Ativar/desativar autenticação Saml para o servidor
cert_id
string
Certificado do provedor de identidade (fornecido pelo IdP)
URL_idp
string
URL do provedor de identidade (fornecido pelo IdP)
emissor_de_idp
string
Emissor do provedor de identidade (fornecido pelo IdP)
público-alvo do IDP
string
Público-alvo do provedor de identidade (definido na configuração do IdP). Opcional no Looker. Defina isso apenas se quiser que o Looker valide o valor do público retornado pelo IdP.
permitido_deslocamento_de_relógio
integer
Contagem de segundos de deslocamento do relógio para permitir ao validar carimbos de data/hora de declarações.
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
new_user_migration_types
string
Mescla pela primeira vez o login SAML com a conta de usuário existente por endereço de e-mail. Quando um usuário faz login pela primeira vez via saml, essa opção conecta esse usuário à conta existente dele 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"
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.
slug_test
string
Slug para identificar as configurações criadas para executar um teste de configuração do Saml
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
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
integer
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
integer
ID exclusivo
nome
string
Nome do PermissionSet
permissões
string[]
url
string
Link para obter este item
ID_permissão_conjunto
integer
(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
integer
ID exclusivo
modelos
string[]
nome
string
Nome do ModelSet
url
string
Link para obter este item
ID_conjunto_do_modelo
integer
(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
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
integer
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
número inteiro[]
default_new_user_group_ids
número inteiro[]
definir_papéis_de_grupos
booleano
Definir funções de usuários no Looker com base em grupos de Samuel
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"
grupos
Expandir a definição de SamlGroupRead...
id
integer
ID exclusivo
código_do_grupo_de_pesquisadores
integer
ID exclusivo do grupo no Looker
nome_do_grupo_de_pesquisadores
string
Nome do grupo no Looker
nome
string
Nome do grupo em Samuel
papéis
Expandir definição do papel...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
integer
ID exclusivo
nome
string
Nome da função
permissão_definido
(Somente leitura) Conjunto de permissões
ID_permissão_conjunto
integer
(Somente gravação) ID do conjunto de permissões
set_model
(Somente leitura) Conjunto de modelos
ID_conjunto_do_modelo
integer
(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 SAML
groups_with_role_ids
Expandir a definição de SamlGroupWrite...
id
integer
ID exclusivo
código_do_grupo_de_pesquisadores
integer
ID exclusivo do grupo no Looker
nome_do_grupo_de_pesquisadores
string
Nome do grupo no Looker
nome
string
Nome do grupo em Samuel
IDs_do_papel
número inteiro[]
url
string
Link para a configuração do SAML
Atributo auth_requires_role
booleano
Os usuários não terão permissão para fazer login, a menos que uma função seja encontrada no Saml se ela for definida como verdadeira
Atributos do usuário
Expandir definição de SamlUserAttributeRead...
nome
string
Nome do atributo do usuário em Samuel
obrigatório
booleano
Necessário estar na declaração do Saml 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
integer
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 SAML
user_attributes_with_ids
Expandir definição de SamlUserAttributeWrite...
nome
string
Nome do atributo do usuário em Samuel
obrigatório
booleano
Necessário estar na declaração do Saml para que o login seja bem-sucedido
ids_do_atributo_do_usuário
número inteiro[]
url
string
Link para a configuração do SAML
tipo_localizador_de_grupos
string
Identificador de uma estratégia para o Looker encontrar grupos na resposta SAML. Um de ['grouped_attribute_values', 'individual_attributes']
valor_do_grupo_de_grupos
string
Valor do atributo de grupo usado para indicar a associação. Usado quando "groups_finder_type" é definido como "atributos individuais"
página_login_ignorado
booleano
Ignorar a página de login quando a autenticação do usuário for necessária. Em vez disso, redirecione para o IdP imediatamente.
allow_normal_group_membership
booleano
Permitir que usuários com autenticação SAML 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 por SAML herdarão 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 por SAML.
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