Crea URL per l'incorporamento

Versione 4.0.23.6 (più recente)

Crea un URL per l'incorporamento

Crea un URL di incorporamento che viene eseguito come utente Looker che effettua questa chiamata API. ("Incorpora come me") Questo URL di incorporamento può essere utilizzato per creare un'istanza di una sessione di incorporamento Looker in un'applicazione web "Powered by Looker" (PBL).

È simile all'incorporamento privato (https://cloud.google.com/looker/docs/r/admin/embed/private-embed). Anziché accedere all'interfaccia utente web per l'autenticazione, l'utente ha già eseguito l'autenticazione tramite l'API per poter effettuare questa chiamata. Tuttavia, a differenza dell'incorporamento privato, in cui l'utente ha accesso a qualsiasi altra parte della UI di Looker, la sessione web di incorporamento creata richiedendo il metodo EmbedUrlResponse.url in un browser ha accesso solo ai contenuti visibili nel contesto /embed.

Un URL di incorporamento può essere utilizzato una sola volta e deve essere utilizzato entro 5 minuti dalla creazione. Dopo essere stato utilizzato per richiedere una pagina dal server Looker, l'URL non è valido. Le richieste future che utilizzano lo stesso URL avranno esito negativo. Questo serve a evitare gli "attacchi riprodotti".

La proprietà target_url deve essere un URL completo di una pagina dell'interfaccia utente incorporata di Looker: schema, nome host, percorso che inizia con "/embed" e parametri di query. Per caricare una dashboard con ID 56 e con un filtro di Date=1 years, l'URL di incorporamento in looker avrebbe il seguente aspetto: https://myname.looker.com/embed/dashboards/56?Date=1%20years. Il modo migliore per ottenere questo target_url è accedere alla pagina di Looker desiderata nel browser web, copiare l'URL mostrato nella barra degli indirizzi del browser, inserire "/embed" dopo l'host/porta e incollarlo nella proprietà target_url come valore di stringa tra virgolette in questa richiesta API.

Nota sulla sicurezza

Proteggi questo URL di incorporamento come faresti con un token di accesso o con delle credenziali tramite password: non scriverlo su disco, non passarlo a una terza parte e passalo solo tramite un trasporto criptato HTTPS sicuro.

Richiesta

POST /embed/token_url/me
Tipo di dati
Descrizione
Richiesta
HTTPRequest
body
HTTPBody
Espandi definizione HTTPBody...
body
Parametri di incorporamento
Espandi definizione EmbedParams...
url_target
string
L'URL completo della pagina dell'interfaccia utente di Looker da visualizzare nel contesto di incorporamento. Ad esempio, per visualizzare la dashboard con ID 34, "target_url" sarebbe simile a "https://mycompany.looker.com:9999/dashboards/34". "target_uri" DEVE contenere uno schema (HTTPS), un nome di dominio e un percorso URL. È necessario includere la porta se è necessaria per raggiungere il server Looker dai client del browser. Se l'istanza di Looker si trova dietro un bilanciatore del carico o un altro proxy, "target_uri" deve essere il nome di dominio e la porta visibili al pubblico necessari per raggiungere l'istanza di Looker, non il nome effettivo della macchina di rete interna dell'istanza di Looker.
lunghezza_sessione
integer
Numero di secondi di validità della sessione di incorporamento SSO dopo l'inizio della sessione di incorporamento. Il valore predefinito è 300 secondi. La durata massima della sessione accettata è 2592000 secondi (30 giorni).
force_logout_login
boolean
Quando il valore è true, la sessione di incorporamento elimina definitivamente ogni stato di accesso di Looker residuo (ad esempio nei cookie del browser) prima di creare un nuovo stato di accesso con le informazioni utente di incorporamento specificate. Il valore predefinito è true.

Risposta

200: URL per l'incorporamento

Tipo di dati
Descrizione
(oggetto)
url
string
L'URL per l'incorporamento. Qualsiasi modifica a questa stringa renderà l'URL inutilizzabile.

400: Richiesta errata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

404: Non trovata

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

409: Risorsa già esistente

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione

422: Errore di convalida

Tipo di dati
Descrizione
messaggio
string
Error details (Dettagli errore)
Espandi definizione ValidationErrorDetails...
campo
string
Campo con errore
codice
string
Codice di errore
messaggio
string
Messaggio informativo sull'errore
documentazione_url
string
Link alla documentazione
documentazione_url
string
Link alla documentazione

429: Troppe richieste

Tipo di dati
Descrizione
(oggetto)
messaggio
string
Error details (Dettagli errore)
documentazione_url
string
Link alla documentazione