DokumentationWorkfrontWorkfront-Handbuch

Erstellen von OAuth2-Programmen für Workfront Integrationen

Last update: Tue Dec 31 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Admin

Als Adobe Workfront können Sie OAuth2-Programme für Ihre Instanz von Workfront erstellen, die anderen Programmen den Zugriff auf Workfront ermöglichen. Ihre Benutzer können dann diesen anderen Anwendungen die Berechtigung erteilen, auf ihre Workfront Daten zuzugreifen. Auf diese Weise können Sie integrieren Mit Anwendungen Ihrer Wahl, einschließlich eigener Anwendungen.

Beim Erstellen einer OAuth2-Anwendung generieren Sie eine Client-ID und ein 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 Art von Zugriffs-Link zwischen einer App und einem Server wie Workfront.

Zugriffsanforderungen

Erweitern Sie , um die Zugriffsanforderungen für die -Funktion 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 Beliebig
Adobe Workfront Lizenz

Neu: Standard

Oder

Aktuell:Plan
Konfigurationen der Zugriffsebene Sie müssen Workfront sein.

Weitere Informationen zu den Informationen in dieser Tabelle finden Sie unter Zugriffsanforderungen in der Dokumentation zu Workfront.

OAuth2 - Übersicht

Angenommen, eine Anwendung muss bestimmte 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 als dieser Benutzer auf Workfront zugreifen. Wenn Ihr Benutzer ClientApp den Benutzernamen und das Passwort gibt, kann ClientApp auf alle Daten zugreifen, auf die der Benutzer zugreifen kann. Dies ist ein Sicherheitsrisiko, da ClientApp nur einen kleinen, spezifischen Satz von Informationen benötigt.

Wenn Sie eine OAuth2-App für ClientApp erstellen, geben Sie im Wesentlichen an, Workfront ClientApp berechtigt ist, auf Workfront zuzugreifen, jedoch nur, wenn der Benutzer, auf dessen Konto ClientApp zugreift, die Berechtigung für den Zugriff erteilt.

Erstellen eines OAuth2-Programms

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

Anwendungstyp
Am besten geeignet für
Authentifizierungsmethode
Maschine-zu-Maschine-Anwendung

Optimiert 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)

Optimiert für mobile oder Single Page Applications (SPAs)

Beispiele:

  • Javascript

  • Angular

  • React

  • Vue

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

Optimiert für Server-seitige Anwendungen, die Anmeldeinformationen und Token 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 mit Server-Authentifizierung (JWT-Fluss) create-an-oauth2-application-using-server-authentication-jwt-flow

  1. Klicken Sie auf das Hauptmenü-Symbol Hauptmenü in der oberen rechten Ecke von Adobe Workfront oder (falls verfügbar) klicken Sie auf das Hauptmenü-Symbol Hauptmenü in der oberen linken Ecke und klicken Sie dann auf ​ ​Setup Setup-Symbol .

  2. Klicken Sie im linken Navigationsbereich auf System und wählen Sie dann OAuth2-Anwendungen.

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

  4. Wählen Sie im Feld Neue OAuth2 die Option Anwendung von Computer zu Computer aus.

  5. Geben Sie einen Namen für das neue Programm ein, z. B. "Workfront for 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-Geheimnis

    Dieses Feld wird automatisch generiert

    WICHTIG:

    Kopieren Sie den Inhalt dieses Felds in eine andere sichere Datei, bevor Sie diese Seite schließen. Dieser geheime Schlüssel wird nicht mehr angezeigt.

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

    1. Klicken Sie auf das Symbol Löschen, das aktuelle Client-Geheimnis zu löschen.

    2. Klicken Sie auf Client-Geheimnis hinzufügen, um ein neues Client-Geheimnis zu generieren.
    Öffentliche Schlüssel

    Server-zu-Server-Apps verwenden öffentliche und private Schlüssel für die 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 Schlüsselpaar aus öffentlichem/privatem Schlüssel generieren und geben Sie dann den öffentlichen Schlüssel für die andere Anwendung frei.
    Name Dies ist der gleiche Name, den Sie der App gegeben haben. Dieses Feld darf nicht leer sein.
    Beschreibung Geben Sie eine Beschreibung für die Integration ein.

  8. Klicken Sie auf Speichern.

Anweisungen zur Konfiguration und Verwendung der OAuth2-Anwendung mit Benutzeranmeldeinformationen (Autorisierungs-Code-Fluss) finden Sie unter Konfigurieren und Verwenden der benutzerdefinierten OAuth 2-Anwendungen Ihres Unternehmens mithilfe von JWT-Fluss.

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

NOTE
Wenn Sie eine Anwendung erstellen, um eine Verbindung zu Workfront Fusion herzustellen, verwenden Sie eine der folgenden Umleitungs-URLs:
  • https://app.workfrontfusion.com/oauth/cb/workfront-workfront
  • https://app-eu.workfrontfusion.com/oauth/cb/workfront-workfront (EU-Rechenzentrum)
  • https://app-az.workfrontfusion.com/oauth/cb/workfront-workfront (Azure Data Center)

  1. Klicken Sie auf das Hauptmenü-Symbol Hauptmenü in der oberen rechten Ecke von Adobe Workfront oder (falls verfügbar) klicken Sie auf das Hauptmenü-Symbol Hauptmenü in der oberen linken Ecke und klicken Sie dann auf ​ ​Setup Setup-Symbol .

  2. Klicken Sie im linken Navigationsbereich auf System und wählen Sie dann OAuth2-Anwendungen.

  3. Klicken Sie App-Integration erstellen.

    Die Neue OAuth2-Anwendung wird angezeigt.

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

  5. Geben Sie einen Namen für das neue OAuth2-Programm ein, z. B. "Workfront for 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-Geheimnis

    Dieses Feld wird automatisch generiert

    WICHTIG:

    Kopieren Sie den Inhalt dieses Felds in eine andere sichere Datei, bevor Sie diese Seite schließen. Dieser geheime Schlüssel wird nicht mehr angezeigt.

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

    1. Klicken Sie auf das Symbol Löschen, das aktuelle Client-Geheimnis zu löschen.

    2. Klicken Sie auf Client-Geheimnis hinzufügen, um ein neues Client-Geheimnis zu generieren.
    Umleitungs-URLs Benutzer werden zu diesem Pfad weitergeleitet, nachdem sie sich bei Workfront authentifiziert haben.
    Token-Rotation aktualisieren 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.
    Absolute Aktualisierungstoken-Gültigkeit Wählen Sie die Zeitspanne aus, für die ein Aktualisierungstoken vorhanden sein soll, bevor es abläuft. Nach Ablauf müssen sich Ihre Benutzer erneut bei der Integration anmelden. Wählen Sie "Kein Ablauf", wenn das Aktualisierungstoken nicht ablaufen soll.
    Gültigkeit des Inaktivitätsaktualisierungs-Tokens

    Wählen Sie die Zeitspanne aus, nach der das Aktualisierungstoken abläuft, wenn der Benutzer in Ihrem System nicht 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 Aktualisierungstoken ab, obwohl die absolute Gültigkeit des Aktualisierungstokens möglicherweise länger eingestellt ist.
    Logo Sie können ein Logo hinzufügen, um diese App leichter identifizierbar zu machen.
    Name Dies ist der gleiche Name, den Sie der App gegeben haben. Dieses Feld darf nicht leer sein.
    Beschreibung Geben Sie eine Beschreibung für die Integration ein.
    App Description URL Dabei kann es sich um einen Link zu einer „Über uns“-Seite oder um eine Seite mit weiteren Informationen zur Integration handeln.

  8. Klicken Sie auf Speichern.

Anweisungen zur Konfiguration und Verwendung der OAuth2-Anwendung mit Benutzeranmeldeinformationen (Autorisierungs-Code-Fluss) finden Sie unter Konfigurieren und Verwenden der benutzerdefinierten OAuth 2-Anwendungen Ihres Unternehmens mithilfe eines Autorisierungs-Code-Flusses.

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

  1. Klicken Sie auf das Hauptmenü-Symbol Hauptmenü in der oberen rechten Ecke von Adobe Workfront oder (falls verfügbar) klicken Sie auf das Hauptmenü-Symbol Hauptmenü in der oberen linken Ecke und klicken Sie dann auf ​ ​Setup Setup-Symbol .

  2. Klicken Sie im linken Navigationsbereich auf System und wählen Sie dann OAuth2-Anwendungen.

  3. Klicken Sie App-Integration erstellen.

    Das Neue OAuth2-Anwendung wird angezeigt.

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

  5. Geben Sie einen Namen für das neue OAuth2-Programm 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 zu diesem Pfad weitergeleitet, nachdem sie sich bei Workfront authentifiziert haben.
    Aktualisierungstoken jedes Mal drehen, wenn es verwendet wird 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.
    Absolute Gültigkeit Wählen Sie die Zeitspanne aus, für die ein Aktualisierungstoken vorhanden sein soll, bevor es abläuft. Nach Ablauf müssen sich Ihre Benutzer erneut bei der Integration anmelden. Wählen Sie "Kein Ablauf", wenn das Aktualisierungstoken nicht ablaufen soll.
    Gültigkeit bei Inaktivität

    Wählen Sie die Zeitspanne aus, nach der das Aktualisierungstoken abläuft, wenn der Benutzer in Ihrem System nicht 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 Aktualisierungstoken ab, obwohl die absolute Gültigkeit des Aktualisierungstokens möglicherweise länger eingestellt ist.
    Logo Sie können ein Logo hinzufügen, um diese App leichter identifizierbar zu machen.
    Name Dies ist der gleiche Name, den Sie der App gegeben haben. Dieses Feld darf nicht leer sein.
    Beschreibung Geben Sie eine Beschreibung für die Integration ein.
    Name des Entwicklers Dies ist der Name des Entwicklers, der die OAuth2-Anwendung einrichtet.
    E-Mail-Adresse des Entwicklers Dies ist die E-Mail-Adresse des Entwicklers, der die OAuth2-Anwendung einrichtet.
    URL der Datenschutzrichtlinie Dies ist der Link, unter dem Ihr Unternehmen die Datenschutzrichtlinie speichert.

  8. Klicken Sie auf Speichern.

Konfigurieren und Verwenden der erstellten OAuth2-Anwendung

Für die weitere Konfiguration und Verwendung der erstellten OAuth2-Anwendung sind einige technische Kenntnisse erforderlich, einschließlich API-Aufrufen.

OAuth2-Prozesse für Autorisierungs-Code-Fluss

NOTE
Ihre Benutzer greifen über die API auf OAuth2-Anwendung zu. In diesem Abschnitt werden die Funktionen in allgemeinen Begriffen beschrieben. Er dient nur zu Informationszwecken.
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 Autorisierungs-Code-Flusses.

Autorisierung mit Autorisierungs-Code und Zugriffs-Token authorizing-with-an-authorization-code-and-access-token

  1. ClientApp benötigt einige Informationen von Workfront, daher sendet es eine Anfrage an den /authorize-Endpunkt der Workfront-API. Die Anfrage enthält den code RESPONSE_TYPE, der angibt, dass die Anfrage einen Autorisierungs-Code zurückgeben soll.

  2. Dieser Trigger Workfront eine Authentifizierungsaufforderung an den Benutzer senden. Der Benutzer kann seine Anmeldeinformationen in die Eingabeaufforderung eingeben, wodurch Workfront 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 Autorisierungs-Code an ClientApp.

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

    • Der Autorisierungs-Code, der in Schritt 3 an ClientApp gesendet wurde. Dadurch wird die spezifische Instanz der Benutzerberechtigung identifiziert.
    • Das Client-Geheimnis, das beim Einrichten der ClientApp OAuth2-App in Workfront generiert wurde. Auf diese Weise können Workfront feststellen, dass die Anfrage von ClientApp stammt.

  5. Wenn der Autorisierungs-Code und das Client-Geheimnis korrekt sind, sendet Workfront ein Zugriffs-Token an ClientApp. Dieses Zugriffstoken wird direkt von Workfront an ClientApp gesendet und kann von keinem anderen Benutzer und keiner anderen 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 zum Erfassen eines Aktualisierungs-Tokens ist identisch mit dem Verfahren, das im Abschnitt Autorisieren mit einem Autorisierungs-Code und Zugriffs-Token beschrieben wird. Die Anfrage für den Autorisierungs-Code enthält den offline_access, der angibt, dass die Anfrage ein Anfrage-Token zusammen mit dem Autorisierungs-Code zurückgeben soll.

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