SSO-Einbettungs-URL erstellen

Version 3.1.23.2

SSO-Einbettungs-URL erstellen

Erstellt eine SSO-Einbettungs-URL und signiert sie kryptografisch mit einem Einbettungs-Secret. Diese signierte URL kann dann verwendet werden, um eine Looker-Einbettungssitzung in einer PBL-Webanwendung zu instanziieren. Nehmen Sie keine Änderungen an dieser URL vor. Jede Änderung kann die Signatur ungültig machen und dazu führen, dass die URL nicht in eine Looker-Einbettungssitzung geladen wird.

Eine signierte SSO-URL kann nur einmal verwendet werden. Nachdem sie zum Anfordern einer Seite vom Looker-Server verwendet wurde, ist die URL ungültig. Zukünftige Anfragen mit derselben URL schlagen fehl. Dadurch sollen „Replay-Angriffe“ verhindert werden.

Das Attribut target_url muss eine vollständige URL einer Looker-UI-Seite sein – Schema, Hostname, Pfad und Abfrageparameter. Zum Laden eines Dashboards mit der ID 56 und dem Filter Date=1 years würde die Looker-URL so aussehen: https:/myname.looker.com/dashboards/56?Date=1%20years. Rufen Sie dazu am besten die gewünschte Looker-Seite in Ihrem Webbrowser auf, kopieren Sie die in der Adressleiste des Browsers angezeigte URL und fügen Sie sie in dieser API-Anfrage als Wert in Anführungszeichen in das Attribut target_url ein.

Berechtigungen für den eingebetteten Nutzer werden durch die Gruppen, in denen der eingebettete Nutzer Mitglied ist (group_ids-Property), und die Listen der Modelle und Berechtigungen definiert, die dem eingebetteten Nutzer zugewiesen sind. Sie müssen mindestens Werte für die Property „group_ids“ oder für die Properties „models“ und „Berechtigungen“ angeben. Diese Properties sind additiv. Ein eingebetteter Nutzer kann Mitglied bestimmter Gruppen sein UND Zugriff auf Modelle und Berechtigungen erhalten.

Der Zugriff des eingebetteten Nutzers besteht aus den Berechtigungen, die von den „group_ids“, „models“ und „permissions“-Properties gewährt werden.

Diese Funktion setzt nicht unbedingt voraus, dass zum Zeitpunkt der Erstellung der SSO-Einbettungs-URL alle Group_ids, Namen von Nutzerattributen oder Modellnamen vorhanden sind. Unbekannte „group_id“-, Nutzerattribut- oder Modellnamen werden an die Ausgabe-URL übergeben. Wenn Sie potenzielle Probleme mit einer eingebetteten SSO-URL diagnostizieren möchten, können Sie die signierte URL in das Textfeld „URI-Validator einbetten“ in <your looker instance>/admin/embed kopieren.

Der Parameter secret_id ist optional. Wenn kein Wert angegeben ist, muss der Wert die ID eines in der Looker-Instanz definierten aktiven Secrets sein. Andernfalls wird die URL mit dem neuesten aktiven Secret signiert, das in der Looker-Instanz definiert ist.

Sicherheitshinweis

Schützen Sie diese signierte URL wie ein Zugriffstoken oder ein Passwort. Schreiben Sie sie nicht auf das Laufwerk, geben Sie sie nicht an Dritte weiter und leiten Sie sie nur über einen sicheren HTTPS-Verschlüsselungstransport weiter.

Anfrage

POST /Embed/sso_url
Datentyp
Beschreibung
Anfrage
HTTPRequest
body
HTTP-Text
HTTPBody-Definition maximieren...
body
SSO-Parameter
EmbedSsoParams-Definition maximieren...
target_url
String
Die vollständige URL der Looker-UI-Seite, die im eingebetteten Kontext angezeigt wird. Um das Dashboard mit der ID 34 anzuzeigen, würde „target_url“ in etwa so aussehen: „https://mycompany.looker.com:9999/dashboards/34“. „target_uri“ MUSS ein Schema (HTTPS), einen Domainnamen und einen URL-Pfad enthalten. Der Port muss enthalten sein, wenn der Looker-Server über Browserclients erreicht werden muss. Wenn sich die Looker-Instanz hinter einem Load-Balancer oder einem anderen Proxy befindet, muss „target_uri“ der öffentlich zugängliche Domainname und der Port sein, die zum Erreichen der Looker-Instanz erforderlich sind, nicht der tatsächliche interne Netzwerkmaschinenname der Looker-Instanz.
Sitzungslänge
integer
Anzahl der Sekunden, die die SSO-Einbettungssitzung gültig ist, nachdem sie gestartet wurde. Die Standardeinstellung ist 300 Sekunden. Die maximal zulässige Länge der Sitzung beträgt 259.2000 Sekunden (30 Tage).
erzwungene_Abmeldung
boolean
Wenn „true“ festgelegt ist, werden alle verbleibenden Looker-Anmeldestatus (z. B. in Browser-Cookies) dauerhaft gelöscht, bevor ein neuer Anmeldestatus mit den angegebenen eingebetteten Nutzerinformationen erstellt wird. Der Standardwert ist „true“.
Externe_Nutzer-ID
String
Ein Wert aus einem externen System, der den eingebetteten Nutzer eindeutig identifiziert. Da sich die user_ids der eingebetteten Looker-Nutzer bei jeder Einbettungssitzung ändern können, bietet „external_user_id“ die Möglichkeit, eine bekannte, stabile Nutzer-ID über mehrere eingebettete Sitzungen hinweg zuzuweisen.
first_name
String
Vorname des eingebetteten Nutzers. Wenn keine Angabe erfolgt, wird standardmäßig „Embed“ (Einbetten) verwendet
last_name
String
Nachname des eingebetteten Nutzers. Ist keine Angabe vorhanden, wird standardmäßig „User“ verwendet.
user_timezone
String
Legt die Zeitzone des Nutzers für die eingebettete Nutzersitzung fest, wenn die Einstellung „Nutzerspezifische Zeitzonen“ in den Looker-Administratoreinstellungen aktiviert ist. Der Wert „null“ zwingt den eingebetteten Nutzer dazu, die Standardzeitzone der Looker-Anwendung zu verwenden. Sie müssen diese Eigenschaft in der Anfrage auslassen, wenn die Einstellung für nutzerspezifische Zeitzonen deaktiviert ist. Die Zeitzonenwerte werden anhand des IANA-Standards für die Zeitzone validiert und sind in der Drop-down-Liste „Application Time Zone“ (Zeitzone der Anwendung) auf der Seite „Allgemeine Einstellungen“ von Looker zu finden.
Berechtigungen
String[]
Modelle
String[]
Gruppen-IDs
Ganzzahl[]
Externe_Gruppen-ID
String
Ein eindeutiger Wert, der eine exklusive Gruppe von eingebetteten Inhalten identifiziert. Mehrere eingebettete Nutzer mit demselben Wert für „external_group_id“ können Looker-Inhalte miteinander teilen. Nutzer, die mit „external_group_id“ verknüpft sind, können die normalen Looker-Nutzer nicht sehen und keine Nutzer einbetten, die nicht mit dieser „external_group_id“ verknüpft sind.
user_attributes
Objekt
Ein Wörterbuch aus Name/Wert-Paaren, die einen Looker-Nutzerattributnamen mit einem Wert verknüpfen.
Secret-ID
integer
ID des eingebetteten Secrets, das zum Signieren dieser SSO-URL verwendet werden soll. Wenn angegeben, muss der Wert eine ID eines gültigen (aktiven) Secrets sein, das in der Looker-Instanz definiert ist. Wenn keine Angabe erfolgt, wird die URL mit dem neuesten aktiven Einbettungs-Secret signiert, das in der Looker-Instanz definiert ist.

Antwort

200: Signierte SSO-URL

Datentyp
Beschreibung
(Objekt)
URL
String
Die Einbettungs-URL. Wenn Sie diesen String ändern, kann die URL nicht mehr verwendet werden.

400: Ungültige Anfrage

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

404: Nicht gefunden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

409: Ressource ist bereits vorhanden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

422: Validierungsfehler

Datentyp
Beschreibung
nachricht
String
Fehlerdetails
ValidationErrorDetail-Definition maximieren...
Feld
String
Feld mit Fehler
Code
String
Fehlercode
nachricht
String
Fehlermeldung
Dokumentations-URL
String
Link zur Dokumentation
Dokumentations-URL
String
Link zur Dokumentation

429: Zu viele Anfragen

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation