Zu Hauptinhalt springen

Erstellen und Verwalten von OAuth-Clients

OAuth ist ein Standard-Sicherheitsprotokoll für Autorisierung und Delegierung. Damit können Anwendungen von Drittanbietern auf API-Ressourcen zugreifen, ohne die Anmeldedaten des Endbenutzers offenzulegen. Ein OAuth-Client kann einen Autorisierungscode erhalten und ihn gegen ein Zugriffstoken austauschen, das für den Zugriff auf Qlik Cloud-Inhalte über APIs genutzt werden kann.

Erstellen eines OAuth-Clients

OAuth-Clients werden von Mandantenadministratoren über die Verwaltungskonsole auf der Seite „OAuth“ verwaltet.

Mit einem OAuth-Client können Sie Ihre Client-Anwendung in Qlik Cloud integrieren.

Gehen Sie folgendermaßen vor:

  1. Gehen Sie in der Verwaltungskonsole zum Abschnitt Integration und wählen Sie OAuth aus.

  2. Klicken Sie auf Neu erstellen.

  3. Geben Sie dem OAuth-Client im Dialogfeld einen Namen.

  4. Fügen Sie optional eine Beschreibung hinzu.

  5. Geben Sie die Umleitungs-URL für die OAuth-Clientanwendung ein. Qlik Cloud leitet den Benutzer nach einer erfolgreichen Autorisierung nur dann an die Anwendung zurück, wenn die URL in der Zulassungsliste der Umleitungs-URLs aufgeführt ist. URLs müssen mit https:// beginnen, es sei denn, die Domäne ist localhost. In diesem Fall können sie mit http:// beginnen.

    Klicken Sie dann auf Hinzufügen, um die Umleitungs-URL zur Zulassungsliste hinzuzufügen.

    InformationshinweisSie können mehr als eine URL hinzufügen.
  6. Klicken Sie auf Create.

  7. Klicken Sie auf In Zwischenablage kopieren, um die Client-ID und den Client-Schlüssel für später zu speichern. Speichern Sie den Client-Schlüssel an einem sicheren Ort. Klicken Sie auf Erledigt.

Bearbeiten eines OAuth-Clients

Sie können einen OAuth-Client umbenennen, die Beschreibung aktualisieren oder die Umleitungs-URLs verwalten.

Gehen Sie folgendermaßen vor:

  1. Gehen Sie in der Verwaltungskonsole zum Abschnitt Integration und wählen Sie OAuth aus. Wählen Sie den OAuth-Client aus, den Sie bearbeiten möchten. Klicken Sie auf ... und wählen Sie dann Bearbeiten aus.
  2. Ändern Sie im Dialogfeld die OAuth-Clientoptionen wie erforderlich.
  3. Klicken Sie auf Speichern.

Veröffentlichen eines OAuth-Clients

Erstellte OAuth-Clients sind automatisch an den Mandanten gebunden, mit dem sie erstellt wurden. Sie können einen OAuth-Client so konfigurieren, dass er freigegeben wird und allen anderen Mandanten einer Region zur Verfügung steht. Die Anwendungen von Drittanbietern, die eine Verbindung mit Qlik Cloud herstellen, können dann die gleiche Client-ID für alle Qlik Cloud-Mandanten haben. Der Anwendungsbesitzer kann ohne Eingreifen eines Mandantenadministrators geheime Schlüssel wechseln und die Konfiguration aktualisieren. Mandantenadministratoren müssen keine Anmeldedaten verwalten oder Konfigurationsdetails kennen.

Damit andere Mandanten eine Verbindung mit einem OAuth-Client herstellen können, muss dieser veröffentlicht werden.

Gehen Sie folgendermaßen vor:

  1. Wählen Sie in der Verwaltungskonsole im Abschnitt OAuth den OAuth-Client aus, den Sie veröffentlichen möchten. Klicken Sie auf ... und wählen Sie Veröffentlichen aus.
  2. Klicken Sie auf Veröffentlichen.

Wenn ein Benutzer zu einer externen Website navigiert, die Qlik OAuth verwendet, wird er aufgefordert, den Mandanten-Hostnamen und dann die Benutzeranmeldedaten einzugeben, es sei denn, der Benutzer hat bereits eine aktive SaaS-Sitzung. Bei der ersten Anmeldung bei einem externen OAuth-Client ist die Zustimmung eines Mandantenadministrators erforderlich. Nach der Genehmigung wird der neue OAuth-Client in der Verwaltungskonsole angezeigt.

Zustimmungsmethode

Es gibt zwei Optionen für die Zustimmung: Erforderlich und Vertrauenswürdig. Bei der Option Erforderlich wird bei der Autorisierung mit dem OAuth-Client jedes Mal die Zustimmung angefordert, wenn für den Benutzer ein neuer Bereich angefordert wird. Bei der Option Vertrauenswürdig erhält der Benutzer keine Eingabeaufforderung. Für nicht veröffentlichte Clients kann nur Vertrauenswürdig verwendet werden. Für veröffentlichte Clients ist die Zustimmungsmethode immer Erforderlich.

Anzeigen und Kopieren der OAuth-Konfiguration

Wählen Sie im Abschnitt OAuth der Verwaltungskonsole die Option OAuth-Konfiguration anzeigen aus, um die Konfiguration als Code-Snippet und eine zu kopierende URL anzuzeigen.

Löschen eines OAuth-Clients

Sie können einen OAuth-Client löschen, wenn er nicht mehr benötigt wird oder wenn Sie den Zugriff widerrufen möchten.

Gehen Sie folgendermaßen vor:

  1. Gehen Sie in der Verwaltungskonsole zum Abschnitt Integration und wählen Sie OAuth aus. Wählen Sie den OAuth-Client aus, den Sie entfernen möchten, und klicken Sie auf Löschen.

    InformationshinweisSie können mehr als einen OAuth-Client gleichzeitig entfernen.
  2. Bestätigen Sie das Löschen des OAuth-Clients.

Verwalten von Client-Schlüsseln

In manchen Fällen müssen Sie einen Client-Schlüssel hinzufügen oder entfernen, beispielsweise wenn ein Client-Schlüssel kompromittiert ist oder wenn Ihre Sicherheitsrichtlinie eine regelmäßige Aktualisierung des Client-Schlüssels vorschreibt. Sie können auch mehrere Client-Schlüssel hinzufügen, um Ausfallzeiten in der Anwendung zu vermeiden. Sie können z. B. einen zweiten Schlüssel erstellen, den neuen Schlüssel in der Client-Anwendung bereitstellen und dann den alten Schlüssel löschen.

Gehen Sie folgendermaßen vor:

  1. Gehen Sie in der Verwaltungskonsole zum Abschnitt Integration und wählen Sie OAuth aus. Wählen Sie den OAuth-Client aus, den Sie verwalten möchten. Klicken Sie auf ... und wählen Sie dann Schlüssel verwalten aus.
  2. Gehen Sie im Dialogfeld wie folgt vor:
    • Um einen neuen Client-Schlüssel hinzuzufügen, klicken Sie auf Neuen Client-Schlüssel generieren.
    • Um einen Client-Schlüssel zu entfernen, klicken Sie auf Löschen neben dem Client-Schlüssel.
  3. Klicken Sie auf Schließen.

Erstellen einer OAuth-Client-Anwendung für den Zugriff auf Qlik Cloud

Nachdem Sie einen OAuth-Client bei Qlik Cloud registriert haben, können Sie die zugehörige Client-ID und den Client-Schlüssel in Ihrer eigenen OAuth-Client-Anwendung verwenden. Tutorials zum Erstellen von Client-Anwendungen in einigen der üblichsten Codiersprachen finden Sie im Abschnitt OAuth-Bibliotheken im Entwicklerportal.