Criar URL de incorporação de SSO

Versão 4.0.23.6 (mais recente)

Criar SSO URL incorporado

Cria um URL de incorporação de SSO e o assina criptograficamente com um segredo de incorporação. Esse URL assinado pode ser usado para instanciar uma sessão de incorporação do Looker em um aplicativo da Web da PBL. Não faça nenhuma modificação nesse URL. Qualquer alteração pode invalidar a assinatura e fazer com que o URL não carregue uma sessão de incorporação do Looker.

Um URL incorporado de SSO assinado pode ser usado apenas uma vez. Depois de ser usado para solicitar uma página do servidor do Looker, o URL é inválido. As próximas solicitações que usarem o mesmo URL falharão. Isso evita ataques de repetição.

A propriedade target_url precisa ser um URL completo de uma página da IU do Looker: parâmetros de esquema, nome do host, caminho e consulta. Para carregar um painel com o ID 56 e com um filtro de Date=1 years, o URL do Looker seria semelhante a https:/myname.looker.com/dashboards/56?Date=1%20years. A melhor maneira de ver esse target_url é navegar até a página do Looker desejada no seu navegador da Web, copiar o URL mostrado na barra de endereço do navegador e colá-lo na propriedade target_url como um valor de string entre aspas nessa solicitação de API.

As permissões do usuário incorporado são definidas pelos grupos dos quais o usuário incorporado é membro (propriedade group_ids) e pelas listas de modelos e permissões atribuídas ao usuário incorporado. No mínimo, você precisa fornecer valores para a propriedade group_ids ou para as propriedades de modelos e permissões. Essas propriedades são aditivas. Um usuário incorporado pode ser membro de determinados grupos E receber acesso a modelos e permissões.

O acesso do usuário incorporado é a união de permissões concedidas pelas propriedades group_ids, models e permissões.

Essa função não exige estritamente que todos os group_ids, nomes de atributo de usuário ou nomes de modelo existam no momento em que o URL de incorporação de SSO é criado. group_id desconhecido, nomes de atributos de usuários ou nomes de modelos serão transmitidos ao URL de saída. Para diagnosticar possíveis problemas com um URL de incorporação de SSO, você pode copiar o URL assinado na caixa de texto "Incorporar URI" em <your looker instance>/admin/embed.

O parâmetro secret_id é opcional. Se especificado, o valor precisa ser o código de uma chave secreta ativa definida na instância do Looker. Se não for especificado, o URL será assinado usando a chave secreta mais recente definida na instância do Looker.

Nota de segurança

Proteja esse URL assinado como você faria com um token de acesso ou com credenciais de senha. Não o grave no disco, não o transmita a terceiros e só o passe por um transporte criptografado HTTPS seguro.

Solicitação

POSTAR /embed/sso_url
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
Parâmetros de SSO
Expandir a definição de EmbedSsoParams...
target_url
string
O URL completo da página da IU do Looker que será exibida no contexto de incorporação. Por exemplo, para exibir o painel com o ID 34, "target_url" seria: "https://mycompany.looker.com:9999/dashboards/34". "target_uri" PRECISA conter um esquema (HTTPS), um nome de domínio e um caminho de URL. A porta precisa ser incluída se for necessário para acessar o servidor do Looker em clientes de navegador. Se a instância do Looker estiver por trás de um balanceador de carga ou outro proxy, "target_uri" precisará ser o nome de domínio público e a porta necessária para acessar a instância do Looker, não o nome real da máquina de rede interna dessa instância.
duração_da_sessão
integer
Quantidade de segundos que a sessão de incorporação de SSO será válida após o início da sessão de incorporação. O padrão é 300 segundos. A duração máxima da sessão aceita é de 259.200.000 segundos (30 dias).
forçar_logout_login
booleano
Quando definido como "true", a sessão de incorporação limpa todos os estados de login residuais do Looker (como nos cookies do navegador) antes de criar um novo estado de login com as informações do usuário incorporadas fornecidas. O padrão é "true".
ID_usuário_externo
string
Um valor de um sistema externo que identifica exclusivamente o usuário incorporado. Como os user_ids de usuários incorporados do Looker podem mudar a cada sessão de incorporação, o atributo external_user_id fornece uma maneira de atribuir um identificador de usuário estável e conhecido em várias sessões de incorporação.
first_name
string
Nome do usuário incorporado. Se não for especificado, o padrão será "Incorporar".
last_name
string
Sobrenome do usuário incorporado. Se não for especificado, o padrão será "Usuário"
fuso horário do usuário
string
Define o fuso horário do usuário para a sessão de usuário incorporada, se a configuração de fusos horários específicos do usuário estiver ativada nas configurações de administrador do Looker. Um valor "nulo" força o usuário incorporado a usar o fuso horário padrão do aplicativo Looker. Você PRECISA omitir essa propriedade da solicitação se a configuração de fusos horários específicos do usuário estiver desativada. Os valores de fuso horário são validados em relação ao padrão de fuso horário da IANA e podem ser vistos na lista suspensa "Fuso horário do aplicativo", na página de administração das configurações gerais do Looker.
permissões
string[]
modelos
string[]
IDs_do_grupo
string[]
ID_grupo_externo
string
Um valor exclusivo que identifica um grupo exclusivo. Vários usuários incorporados que usam o mesmo valor "external_group_id" poderão compartilhar conteúdo do Looker entre si. Os usuários de conteúdo e incorporação associados ao `external_group_id` não poderão ser acessados pelos usuários normais do Looker ou incorporados não associados a esse `external_group_id`.
Atributos do usuário
objeto
Um dicionário de pares de nome-valor que associam um nome de atributo de usuário do Looker a um valor.
id_secreto
string
ID do segredo incorporado a ser usado para assinar este URL de SSO. Se especificado, o valor precisa ser um ID de um secret válido (ativo) definido na instância do Looker. Se não for especificado, o URL será assinado com a chave secreta incorporada mais recente definida na instância do Looker.

Resposta

200: URL de SSO assinado

Tipo de dados
Descrição
(objeto)
EmbedUrlResponse (em inglês)
url
string
O URL incorporado. Qualquer modificação nesta string inutilizará o URL.

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

404: não encontrado

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

409: recurso já existe

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

429: Solicitações demais

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