Criar URL incorporado

Versão 4.0.23.6 (mais recente)

Criar um URL incorporado

Cria um URL incorporado que é executado como o usuário do Looker que faz essa chamada de API. ("Incorporar como eu") Esse URL de incorporação pode ser usado para instanciar uma sessão de incorporação do Looker em um aplicativo da Web "Powered by Looker" (PBL).

Isso é semelhante à incorporação privada (https://cloud.google.com/looker/docs/r/admin/embed/private-embed). Em vez de fazer login na IU da Web para autenticar, o usuário já foi autenticado na API para fazer essa chamada. No entanto, diferentemente da incorporação privada, em que o usuário tem acesso a qualquer outra parte da IU do Looker, a sessão da Web incorporada criada ao solicitar o EmbedUrlResponse.url em um navegador só tem acesso ao conteúdo visível no contexto /embed.

Um URL de incorporação só pode ser usado uma vez e precisa ser usado até cinco minutos depois da criação. Depois de ser usado para solicitar uma página do servidor do Looker, o URL é inválido. As solicitações futuras 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 de IU incorporada do Looker: esquema, nome do host, caminho que começa com "/embed" e parâmetros de consulta. Para carregar um painel com o ID 56 e um filtro de Date=1 years, o URL de incorporação do Looker seria semelhante a https://myname.looker.com/embed/dashboards/56?Date=1%20years. A melhor maneira de ver esse target_url é navegar até a página do Looker desejada no navegador da Web, copiar o URL mostrado na barra de endereço do navegador, inserir "/embed" depois do host/porta e colá-lo na propriedade target_url como um valor de string entre aspas nessa solicitação de API.

Nota de segurança

Proteja esse URL incorporado 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/token_url/me
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
Parâmetros incorporados
Expandir a definição de EmbedParams...
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".

Resposta

200: URL incorporado

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