DokumentationWorkfrontWorkfront-Handbuch

Erstellen von OAuth2-Anwendungen für Workfront -Integrationen

Last update: Wed Jul 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Admin

Als Adobe Workfront -Administrator können Sie OAuth2-Anwendungen für Ihre Instanz von Workfront erstellen, die anderen Anwendungen den Zugriff auf Workfront ermöglichen. Ihre Benutzer können dann diesen anderen Anwendungen Berechtigungen für den Zugriff auf ihre Workfront -Daten erteilen. Auf diese Weise können Sie die mit Anwendungen Ihrer Wahl, einschließlich Ihrer eigenen internen Anwendungen.

Wenn Sie eine OAuth2 -Anwendung erstellen, generieren Sie eine Client-ID und einen Client-Geheimnis. Ihre Benutzer können dann die Client-ID in API-Aufrufen verwenden, um sie in die von Ihnen erstellte Anwendung zu integrieren.

NOTE
Im Kontext von OAuth2 bezieht sich "Erstellen einer App"auf den Prozess der Erstellung einer solchen Zugriffsverknüpfung zwischen einer App und einem Server wie Workfront.

Zugriffsanforderungen

Erweitern Sie , um die Zugriffsanforderungen für die Funktionalität in diesem Artikel anzuzeigen.

Sie müssen über folgenden Zugriff verfügen, um die Schritte in diesem Artikel ausführen zu können:

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Adobe Workfront plan* Alle
Adobe Workfront license*

Neu: Standard

Oder

Aktuell:Plan
Konfigurationen auf Zugriffsebene* Sie müssen ein Workfront -Administrator sein.

*Wenden Sie sich an Ihren Workfront -Administrator, um zu erfahren, welchen Plan, welchen Lizenztyp oder welchen Zugriff Sie haben.

OAuth2-Übersicht

Stellen Sie sich vor, eine Anwendung muss einige spezifische Informationen aus Workfront abrufen. Eine Anwendung, die Informationen anfordert, wird als Client bezeichnet. In diesem Beispiel lautet der Client-Name ClientApp. ClientApp benötigt Zugriff auf die Informationen eines bestimmten Benutzers und muss daher auf Workfront als diesen Benutzer zugreifen. Wenn Ihr Benutzer ClientApp seinen Benutzernamen und sein Kennwort gibt, kann ClientApp auf alle Daten zugreifen, auf die der Benutzer zugreifen kann. Dies ist ein Sicherheitsrisiko, da ClientApp nur einen kleinen, spezifischen Satz an Informationen benötigt.

Wenn Sie eine OAuth2-App für ClientApp erstellen, teilen Sie Workfront im Wesentlichen mit, dass ClientApp auf Workfront zugreifen darf, allerdings nur, wenn der Benutzer, auf dessen Konto ClientApp zugreift, die Berechtigung für den Zugriff erteilt.

Erstellen einer OAuth2-Anwendung

Wählen Sie beim Erstellen einer OAuth2-Anwendung den Anwendungstyp aus, der den Anforderungen Ihrer Integration am besten entspricht.

Anwendungstyp
Best for
Authentifizierungsmethode
Maschine-zu-Maschine-Anwendung

Best Practices für CLIs, Daemons oder Skripte, die auf Ihrem Server ausgeführt werden

Beispiele:

  • Shell

  • Python

Authentifizierung mit JSON-Web-Token mit Verschlüsselung des öffentlichen/privaten Schlüsselpaares.
Single Page Application (einseitige Web-Anwendung)

Optimal für mobile oder einseitige Webanwendungen

Beispiele:

  • Javascript

  • Angular

  • React

  • Vue

Authentifizierung durch OAuth 2.0 Authorization Code Flow mit Proof Key for Code Exchange (PKCE).
Web-Anwendung

Optimale Lösung für serverseitige Anwendungen, die Anmeldeinformationen und Tokens auf dem Server verarbeiten

Beispiele:

  • Go

  • Java

  • ASP.Net

  • Node.js

  • PHP

Authentifizierung über OAuth 2.0 Authorization Code Flow.
NOTE
Sie können bis zu zehn OAuth2-Anwendungen gleichzeitig haben.

Erstellen einer OAuth2-Anwendung mithilfe der Serverauthentifizierung (JWT-Fluss) create-an-oauth2-application-using-server-authentication-jwt-flow

  1. Klicken Sie auf das Symbol Hauptmenü Hauptmenü oben rechts in Adobe Workfront oder (falls verfügbar) auf das Symbol Hauptmenü (6}Hauptmenü oben links und klicken Sie dann auf das Symbol Setup Setup .

  2. Klicken Sie im linken Navigationsbereich auf System und wählen Sie dann OAuth2 Applications aus.

  3. Klicken Sie auf App-Integration erstellen.
    Das Feld Neue OAuth2-Anwendung wird angezeigt.

  4. Wählen Sie im Feld Neue OAuth2-Anwendung die Option Machine to Machine Application.

  5. Geben Sie einen Namen für die neue Anwendung ein, z. B. "Workfront für ClientApp".

  6. Klicken Sie auf Erstellen.

  7. Füllen Sie die Felder für die neue App aus.

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header
    Client-ID Dieses Feld wird automatisch generiert.
    Client secret

    Dieses Feld wird automatisch generiert

    WICHTIG:

    Kopieren Sie den Inhalt dieses Felds in eine andere sichere Datei, bevor Sie diese Seite schließen. Sie werden diesen geheimen Schlüssel nicht mehr sehen können.

    Wenn Sie diesen Schlüssel verlieren, löschen Sie ihn und erstellen Sie ein Client-Geheimnis.

    1. Klicken Sie auf das Symbol Löschen , um den aktuellen Client-Geheimniswert zu löschen.

    2. Klicken Sie auf Client-Geheimnis hinzufügen , um ein neues Client-Geheimnis zu generieren.
    Public Keys

    Server-zu-Server-Apps verwenden öffentliche und private Schlüssel zur Authentifizierung. Führen Sie einen der folgenden Schritte aus:

    • Klicken Sie auf Öffentlichen Schlüssel hinzufügen und geben Sie den öffentlichen Schlüssel aus der anderen Anwendung ein.

    • Klicken Sie auf Generate a public/private keypair und geben Sie dann den öffentlichen Schlüssel für die andere Anwendung frei.
    Name Dies ist der gleiche Name wie die App. Dieses Feld darf nicht leer sein.
    Beschreibung Geben Sie eine Beschreibung für die Integration ein.

  8. Klicken Sie auf Speichern.

Anweisungen zum Konfigurieren und Verwenden der OAuth2-Anwendung mit Benutzeranmeldeinformationen (Fluss des Autorisierungscodes) finden Sie unter Konfigurieren und Verwenden der benutzerdefinierten OAuth 2-Anwendungen Ihres Unternehmens mithilfe des JWT-Flusses.

Erstellen einer OAuth2-Anwendung mit Benutzeranmeldeinformationen (Autorisierungscode-Fluss) create-an-oauth2-application-using-user-credentials-authorization-code-flow

  1. Klicken Sie auf das Symbol Hauptmenü Hauptmenü oben rechts in Adobe Workfront oder (falls verfügbar) auf das Symbol Hauptmenü (6}Hauptmenü oben links und klicken Sie dann auf das Symbol Setup Setup .

  2. Klicken Sie im linken Navigationsbereich auf System und wählen Sie dann OAuth2 Applications aus.

  3. Klicken Sie auf App-Integration erstellen.

    Die neue OAuth2-Anwendung wird angezeigt.

  4. Wählen Sie im Feld Neue OAuth2-Anwendung die Option Webanwendung aus.

  5. Geben Sie einen Namen für die neue OAuth2-Anwendung ein, z. B. "Workfront für ClientApp".

  6. Klicken Sie auf Erstellen.

  7. Füllen Sie die Felder für die neue App aus.

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 layout-auto html-authored no-header
    Client-ID Dieses Feld wird automatisch generiert.
    Client secret

    Dieses Feld wird automatisch generiert

    WICHTIG:

    Kopieren Sie den Inhalt dieses Felds in eine andere sichere Datei, bevor Sie diese Seite schließen. Sie werden diesen geheimen Schlüssel nicht mehr sehen können.

    Wenn Sie diesen Schlüssel verlieren, löschen Sie ihn und erstellen Sie ein Client-Geheimnis.

    1. Klicken Sie auf das Symbol Löschen , um den aktuellen Client-Geheimniswert zu löschen.

    2. Klicken Sie auf Client-Geheimnis hinzufügen , um ein neues Client-Geheimnis zu generieren.
    Umleitungs-URLs Benutzer werden nach der Authentifizierung mit Workfront zu diesem Pfad umgeleitet.
    Aktualisierung der Tokenrotation Aktivieren Sie diese Option, um jedes Mal, wenn ein Refresh-Token verwendet wird, ein neues Refresh-Token zu erstellen. Ihre Anwendung muss das neue Refresh-Token nach jeder Aktualisierung speichern.
    Absoluter Aktualisierungstoken-Ablauf Wählen Sie den Zeitraum aus, für den ein Aktualisierungstoken vorhanden sein soll, bevor es abläuft. Nach Ablauf dieser Frist müssen sich Ihre Benutzer erneut bei der Integration anmelden. Wählen Sie "No expiration", wenn das Aktualisierungstoken nicht ablaufen soll.
    Gültigkeit des Inaktivitätsaktualisierungs-Tokens

    Wählen Sie den Zeitraum aus, nach dem das Aktualisierungstoken abläuft, wenn der Benutzer nicht in Ihrem System aktiv war.

    Wenn beispielsweise die Gültigkeit des Inaktivitäts-Aktualisierungstokens 6 Monate beträgt und sich der Benutzer sechs Monate lang nicht anmeldet, läuft das Aktualisierungs-Token ab, auch wenn der absolute Ablauf des Aktualisierungstokens möglicherweise länger festgelegt ist.
    Logo Sie können ein Logo hinzufügen, um diese App leichter identifizierbar zu machen.
    Name Dies ist der gleiche Name wie die App. Dieses Feld darf nicht leer sein.
    Beschreibung Geben Sie eine Beschreibung für die Integration ein.
    App Description URL Hierbei kann es sich um einen Link zu einer "Info"-Seite oder zu einer Seite mit weiteren Informationen zur Integration handeln.

  8. Klicken Sie auf Speichern.

Anweisungen zum Konfigurieren und Verwenden der OAuth2-Anwendung mit Benutzeranmeldeinformationen (Fluss des Autorisierungscodes) finden Sie unter Konfigurieren und Verwenden der benutzerdefinierten OAuth 2-Anwendungen Ihres Unternehmens mithilfe des Autorisierungscodeflusses.

Erstellen einer OAuth2-Single-Page-Webanwendung mit PKCE create-an-oauth2-single-page-web-application-using-pkce

  1. Klicken Sie auf das Symbol Hauptmenü Hauptmenü oben rechts in Adobe Workfront oder (falls verfügbar) auf das Symbol Hauptmenü (6}Hauptmenü oben links und klicken Sie dann auf das Symbol Setup Setup .

  2. Klicken Sie im linken Navigationsbereich auf System und wählen Sie dann OAuth2 Applications aus.

  3. Klicken Sie auf App-Integration erstellen.

    Das Feld Neue OAuth2-Anwendung wird angezeigt.

  4. Wählen Sie im Feld Neue OAuth2-Anwendung die Option Single Page Web Application.

  5. Geben Sie einen Namen für die neue Anwendung OAuth2 ein, z. B. "Workfront für ClientApp".

  6. Klicken Sie auf Erstellen.

  7. Füllen Sie die Felder für die neue App aus.

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 layout-auto html-authored no-header
    Client-ID Dieses Feld wird automatisch generiert.
    Umleitungs-URLs Benutzer werden nach der Authentifizierung bei Workfront zu diesem Pfad umgeleitet.
    Aktualisierungstoken bei jeder Verwendung drehen Aktivieren Sie diese Option, um jedes Mal, wenn ein Refresh-Token verwendet wird, ein neues Refresh-Token zu erstellen. Ihre Anwendung muss das neue Refresh-Token nach jeder Aktualisierung speichern.
    Absoluter Ablauf Wählen Sie den Zeitraum aus, für den ein Aktualisierungstoken vorhanden sein soll, bevor es abläuft. Nach Ablauf dieser Frist müssen sich Ihre Benutzer erneut bei der Integration anmelden. Wählen Sie "No expiration", wenn das Aktualisierungstoken nicht ablaufen soll.
    Inaktivitätsablauf

    Wählen Sie den Zeitraum aus, nach dem das Aktualisierungstoken abläuft, wenn der Benutzer nicht in Ihrem System aktiv war.

    Wenn beispielsweise die Gültigkeit des Inaktivitäts-Aktualisierungstokens 6 Monate beträgt und sich der Benutzer sechs Monate lang nicht anmeldet, läuft das Aktualisierungs-Token ab, auch wenn der absolute Ablauf des Aktualisierungstokens möglicherweise länger festgelegt ist.
    Logo Sie können ein Logo hinzufügen, um diese App leichter identifizierbar zu machen.
    Name Dies ist der gleiche Name wie die App. Dieses Feld darf nicht leer sein.
    Beschreibung Geben Sie eine Beschreibung für die Integration ein.
    Entwicklername Dies ist der Name des Entwicklers, der die OAuth2-Anwendung eingerichtet hat.
    Entwickler-E-Mail-Adresse Dies ist die E-Mail-Adresse des Entwicklers, der die OAuth2-Anwendung eingerichtet hat.
    URL der Datenschutzrichtlinie Dies ist der Link zu dem Ort, an dem Ihre Organisation die Datenschutzrichtlinie speichert.

  8. Klicken Sie auf Speichern.

Konfigurieren und Verwenden der erstellten OAuth2-Anwendung

Die weitere Konfiguration und Verwendung der erstellten OAuth2-Anwendung erfordert einige technische Kenntnisse, einschließlich API-Aufrufen.

OAuth2-Prozesse für den Autorisierungscode-Fluss

NOTE
Ihre Benutzer greifen über die API auf die Anwendung OAuth2 zu. In diesem Abschnitt wird die Funktionalität allgemein beschrieben und nur zu Informationszwecken bereitgestellt.
Spezifische Anweisungen zur Verwendung der OAuth2-Anwendung, einschließlich spezifischer API-Aufrufe, finden Sie unter Konfigurieren und Verwenden der benutzerdefinierten OAuth 2-Anwendungen Ihres Unternehmens mithilfe des Autorisierungscodeflusses.

Autorisierung mit einem Autorisierungscode und Zugriffstoken authorizing-with-an-authorization-code-and-access-token

  1. ClientApp benötigt einige Informationen von Workfront, daher wird eine Anfrage an den Endpunkt Workfront API /authorize gesendet. Die Anfrage enthält den response_type code , der angibt, dass die Anfrage einen Autorisierungscode zurückgeben soll.

  2. Dieser Trigger Workfront sendet eine Authentifizierungsaufforderung an den Benutzer. Der Benutzer kann seine Anmeldedaten in die Eingabeaufforderung eingeben, wodurch Workfront die Berechtigung zur Kommunikation mit ClientApp erhält. Wenn der Benutzer bereits bei Workfront angemeldet ist, kann dieser Schritt übersprungen werden.

  3. Die Workfront -API sendet einen Autorisierungscode an ClientApp.

  4. ClientApp sendet die folgenden Informationen in einer Anfrage an die Workfront API /token Endpunkt:

    • Der Autorisierungscode, der in Schritt 3 an ClientApp gesendet wurde. Damit wird die spezifische Instanz der Benutzerberechtigungen identifiziert.
    • Das Client-Geheimnis, das beim Einrichten der ClientApp OAuth2-App in Workfront generiert wurde. Dadurch kann Workfront erkennen, dass die Anfrage von ClientApp stammt.

  5. Wenn der Autorisierungscode und das Client-Geheimnis korrekt sind, sendet Workfront ein Zugriffstoken an ClientApp. Dieses Zugriffstoken wird direkt von Workfront an ClientApp gesendet und kann von keinem anderen Benutzer oder von keiner Client-Anwendung angezeigt, kopiert oder verwendet werden.

  6. ClientApp sendet das Zugriffstoken zusammen mit der spezifischen Informationsanfrage an Workfront.

  7. Da das Zugriffstoken korrekt ist, sendet Workfront die Informationen an ClientApp.

Aktualisieren von Zugriffstoken

Aus Sicherheitsgründen laufen Zugriffstoken nach kurzer Zeit ab. Um neue Zugriffstoken zu erhalten, ohne jedes Mal Anmeldeinformationen eingeben zu müssen, verwendet OAuth2 Aktualisierungstoken. Aktualisierungs-Token werden vom Client gespeichert.

Der Prozess für das Abrufen eines Aktualisierungstokens entspricht dem im Abschnitt Autorisierung mit einem Autorisierungs-Code und Zugriffstoken beschriebenen Verfahren. Die Anfrage für den Autorisierungscode enthält den Gültigkeitsbereich "offline_access", der angibt, dass die Anfrage ein Anfrage-Token zusammen mit dem Autorisierungscode zurückgeben soll.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43