Crea URL di incorporamento SSO

Versione 3.1.23.2

Crea URL per l'incorporamento del servizio SSO

Crea un URL di incorporamento SSO e lo firma crittograficamente con un secret di incorporamento. Questo URL firmato può quindi essere utilizzato per creare un'istanza di una sessione di incorporamento Looker in un'applicazione web PBL. Non apportare modifiche a questo URL: qualsiasi modifica potrebbe invalidare la firma e impedire all'URL di caricare una sessione di incorporamento di Looker.

Un URL di incorporamento SSO firmato può essere utilizzato una sola volta. 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 per evitare "attacchi di riproduzione".

La proprietà target_url deve essere un URL completo di una pagina dell'interfaccia utente di Looker: schema, nome host, parametro e parametri di ricerca. Per caricare una dashboard con ID 56 e con un filtro di Date=1 years, l'URL di Looker sarebbe in https:/myname.looker.com/dashboards/56?Date=1%20years. Il modo migliore per ottenere questo URL target_url è andare alla pagina Looker desiderata nel browser web e copiare l'URL mostrato nella barra degli indirizzi del browser e incollarlo nella proprietà target_url come valore di stringa tra virgolette in questa richiesta API.

Le autorizzazioni per l'utente di incorporamento sono definite dai gruppi di cui l'utente di incorporamento è membro (proprietà group_id) e dagli elenchi di modelli e autorizzazioni assegnati all'utente di incorporamento. Come minimo, devi fornire i valori per la proprietà group_id o per entrambe le proprietà modelli e autorizzazioni. Queste proprietà sono cumulative. Un utente incorporato può essere membro di determinati gruppi E ottenere l'accesso a modelli e autorizzazioni.

L'accesso utente incorporato è l'unione delle autorizzazioni concesse dalle proprietà group_id, modelli e autorizzazioni.

Questa funzione non richiede rigorosamente che tutti i group_id, i nomi degli attributi utente o i nomi dei modelli esistano nel momento in cui viene creato l'URL di incorporamento SSO. Il valore di group_id sconosciuto, i nomi degli attributi utente o i nomi dei modelli verranno trasmessi all'URL di output. Per diagnosticare potenziali problemi relativi a un URL di incorporamento SSO, puoi copiare l'URL firmato nella casella di testo dello strumento di convalida dell'URI incorporato in <your looker instance>/admin/embed.

Il parametro secret_id è facoltativo. Se specificato, il valore deve essere l'ID di un secret attivo definito nell'istanza di Looker. Se non specificato, l'URL verrà firmato utilizzando il secret attivo più recente definito nell'istanza di Looker.

Nota sulla sicurezza

Proteggi questo URL firmato come faresti con un token di accesso o con una password, senza scriverlo su disco, non passarlo a terze parti e solo attraverso un trasporto criptato protetto HTTPS.

Richiesta

POST /embed/sso_url
Tipo di dati
Descrizione
Richiesta
HTTPRequest
body
HTTPBody
Espandi definizione HTTPBody...
body
Parametri SSO
Espandi definizione EmbedSsoParams...
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.
id_utente_esterno
string
Un valore di un sistema esterno che identifica in modo univoco l'utente di incorporamento. Poiché gli user_id degli utenti di incorporamento di Looker possono cambiare a ogni sessione di incorporamento, l'external_user_id fornisce un modo per assegnare un identificatore utente stabile e noto in più sessioni di incorporamento.
first_name
string
Nome dell'utente per l'incorporamento. Se non specificato, il valore predefinito è "Incorpora".
last_name
string
Cognome dell'utente per l'incorporamento. Se non specificato, il valore predefinito è 'Utente'
fuso orario utente
string
Imposta il fuso orario dell'utente per la sessione utente di incorporamento, se l'impostazione User Specific Timezones (Fusi orari specifici degli utenti) è abilitata nelle impostazioni di amministrazione di Looker. Un valore "null" obbliga l'utente all'incorporamento a utilizzare il fuso orario predefinito dell'applicazione Looker. Se l'impostazione Fusi orari specifici degli utenti è disattivata, DEVI omettere questa proprietà dalla richiesta. I valori di fuso orario vengono convalidati in base allo standard IANA per il fuso orario e possono essere visualizzati nell'elenco a discesa Fuso orario dell'applicazione nella pagina di amministrazione delle impostazioni generali di Looker.
autorizzazioni
stringa[]
modelli
stringa[]
id_gruppo
Numero intero[]
id_gruppo_esterno
string
Un valore univoco che identifica un gruppo esclusivo di incorporamento. Più utenti incorporati che utilizzano lo stesso valore "external_group_id" potranno condividere tra loro contenuti Looker. Gli utenti di contenuti e di incorporamento associati a "external_group_id" non saranno accessibili ai normali utenti Looker o agli utenti di incorporamento non associati a questo "external_group_id".
attributi_utente
oggetto
Un dizionario di coppie nome-valore che associa il nome di un attributo utente Looker a un valore.
id_segreto
integer
ID del secret di incorporamento da utilizzare per firmare questo URL SSO. Se specificato, il valore deve essere un ID di un secret (attivo) valido definito nell'istanza di Looker. Se non specificato, l'URL verrà firmato con il secret di incorporamento attivo più recente definito nell'istanza di Looker.

Risposta

200: URL SSO firmato

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