Criar sessão de incorporação sem cookies

Versão 4.0.23.6 (mais recente)

Adquirir uma sessão de incorporação sem cookies.

O endpoint da sessão de aquisição nega a necessidade de assinar o URL de incorporação e transmiti-lo como um parâmetro ao login de incorporação. Esse endpoint aceita uma definição de usuário incorporada e a cria ou atualiza. Esse comportamento é semelhante ao login de SSO incorporado, já que ambos podem criar e atualizar dados do usuário incorporados.

O endpoint também aceita um session_reference_token opcional. Se presente e a sessão não tiver expirado e as credenciais corresponderem às credenciais da sessão incorporada, um novo token de autenticação será gerado. Isso permite que a sessão incorporada anexe um novo IFRAME incorporado à sessão de incorporação. A sessão NÃO é estendida nesse cenário. Em outras palavras, o parâmetro session_length é ignorado.

IMPORTANTE: se o session_reference_token for fornecido e a sessão NÃO tiver expirado, o usuário incorporado NÃO será atualizado. Isso é feito por motivos de desempenho e para oferecer suporte ao caso de uso de SSO incorporado, em que o primeiro IFRAME criado em uma página usa um URL assinado e os IFRAMEs criados posteriormente não.

Se o session_reference_token for fornecido, mas a sessão tiver expirado, o token será ignorado e uma nova sessão de incorporação será criada. A definição do usuário incorporado será atualizada nesse cenário.

Se as credenciais não corresponderem às credenciais associadas a um session_reference_token existente, um 404 será retornado.

O endpoint retorna o seguinte:

  • Token de autenticação: um token transmitido para o endpoint /embed/login que cria ou anexa à sessão de incorporação. Esse token pode ser usado uma vez e tem uma duração de 30 segundos.
  • Token de referência de sessão - um token que permanece por toda a sessão. Esse token é usado para gerar novos tokens de API e navegação OU criar novos IFRAMEs incorporados.
  • Token da API: ativo por 10 minutos. O cliente do Looker solicitará esse token quando ele for carregado no iframe.
  • Token de navegação - é válido por 10 minutos. O cliente do Looker solicitará esse token quando ele for carregado no iframe.

Solicitação

POSTAR /embed/cookieless_session/acrere
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
Incorporar detalhes do usuário
Expandir definição de EmbedCookielessSessionAcquire...
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.
token de referência da sessão
string
Token que faz referência à sessão de incorporação e é usado para gerar novos tokens de autenticação, navegação e API.

Resposta

200: Incorporar respostas de sessão de aquisição sem cookies

Tipo de dados
Descrição
token_autenticação
string
Um token de tempo usado para criar ou anexar a uma sessão incorporada no servidor de aplicativos do Looker.
token_autenticação_tl
integer
Tempo de vida útil do token de autenticação em segundos.
token_de_navegação
string
Token usado para carregar e navegar entre as páginas do Looker.
navegação_token_ttl
integer
Vida útil do token de navegação em segundos.
api_token
string
Token usado para chamar as APIs Looker.
api_token_ttl
integer
Vida útil do token da API em segundos.
token de referência da sessão
string
Token que faz referência à sessão de incorporação real. Ele é usado para gerar novos tokens de API, navegação e autenticação. Eles têm curta duração e precisam ser atualizados regularmente. É preciso adquirir um novo token de autenticação para cada IFRAME criado. O session_reference_token precisa ser mantido em segurança, de preferência no servidor de aplicativos de hospedagem de incorporação.
session_reference_token_ttl
integer
Tempo de vida do token de referência da sessão em segundos. Isso é o mesmo que a sessão real.

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