DokumentationWorkfrontWorkfront-Handbuch

Verwalten von API-Schlüsseln

Last update: Fri Apr 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Admin

Um API-Sicherheitslücken zu minimieren, können Adobe Workfront-Administratoren die API-Schlüssel verwalten, mit denen Anwendungen im Auftrag eines Benutzers auf Workfront zugreifen können.

Sie können Ihren aktuellen Administrator-API-Schlüssel zurücksetzen oder entfernen, die API-Schlüssel so konfigurieren, dass sie ablaufen, und die API-Schlüssel für alle Benutzer entfernen.

Beispiele für Anwendungen, die die Workfront-API nutzen:

  • Dokumentenintegrationen wie Dropbox, Google Drive und Workfront DAM
  • Mobile Apps für Workfront
IMPORTANT
Beim Zurücksetzen oder Entfernen eines API-Schlüssels muss jede Anwendung, die die Workfront-API nutzt und sich über diesen API-Schlüssel bei Workfront authentifiziert, neu konfiguriert werden, um wieder Zugriff auf Workfront zu erhalten.

Zugriffsanforderungen

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

Adobe Workfront-Abo
Alle
Adobe Workfront-Lizenz
Plan
Konfigurationen auf Zugriffsebene

Sie müssen Workfront-Administrator sein.

NOTE: Wenn Sie immer noch keinen Zugriff haben, fragen Sie Ihren Workfront-Administrator, ob er zusätzliche Zugriffsbeschränkungen für Ihre Zugriffsstufe festgelegt hat. Informationen dazu, wie ein Workfront-Administrator Ihre Zugriffsebene ändern kann, finden Sie unter Benutzerdefinierte Zugriffsebenen erstellen oder ändern.

Workfront-API-Schlüssel

Jeder Benutzer in Workfront verfügt über einen eindeutigen API-Schlüssel. Dieser Schlüssel wird pro Benutzer generiert, wenn der Benutzer auf eine Integration zugreift, die die Workfront-API nutzt (z. B. die mobile Workfront-App oder eine Dokumentintegration).

NOTE
API-Schlüssel, die Sie in der Produktionsumgebung generieren, werden während der wöchentlichen Aktualisierung in die Vorschauumgebung kopiert. Alle API-Schlüssel, die Sie in der Vorschau-Umgebung generieren, werden während der wöchentlichen Aktualisierung mit Ihren Produktions-API-Schlüsseln überschrieben.

Workfront-Administratoren verfügen auch über einen eindeutigen API-Schlüssel. Wenn eine Anwendung einen Administrator-API-Schlüssel für den Zugriff auf Workfront verwendet, hat die Anwendung Administratorzugriff auf Workfront.

Verwalten eines API-Schlüssels für Administratoren

Sie können den API-Schlüssel für Ihr Administratorbenutzerkonto generieren, zurücksetzen oder entfernen.

NOTE
Sie können auch einen API-Schlüssel über die API generieren. Weitere Informationen finden Sie unter Ereignisabonnement-API Abschnitt in Ereignisabonnement-API.

  1. Klicken Sie auf Hauptmenü icon Klicken Sie oben rechts in Adobe Workfront auf Einrichtung .

  2. Klicks System > Kundeninformationen.

  3. (Bedingt) Führen Sie einen der folgenden Schritte aus:

    So generieren Sie einen API-Schlüssel: Im API-Schlüsseleinstellungen Abschnitt, klicken Sie auf API-Schlüssel generieren.

    Oder
    Zurücksetzen eines API-Schlüssels: In der API-Schlüsseleinstellungen Abschnitt, klicken Sie auf Zurücksetzen, dann Zurücksetzen.

    Oder

    So entfernen Sie den API-Schlüssel: Im API-Schlüsseleinstellungen Abschnitt, klicken Sie auf Entfernen, dann Entfernen.

API-Schlüssel für Benutzer ohne Administratorrechte generieren

Sie können API-Schlüssel für Benutzer in anderen Rollen als dem Workfront-Administrator generieren und verwalten.

NOTE
Dies ist nicht verfügbar, wenn die Workfront-Instanz Ihres Unternehmens mit Adobe IMS aktiviert ist. Wenden Sie sich an Ihren Netzwerk- oder IT-Administrator, wenn Sie weitere Informationen benötigen.

  1. (Bedingt) Wenn Ihr Unternehmen die SSO-Zugriffsverwaltung (Single Sign-On) verwendet, deaktivieren Sie vorübergehend die Option, für die eine SSO-Authentifizierung erforderlich ist.

    1. Klicken Sie auf Hauptmenü icon Klicken Sie oben rechts in Adobe Workfront auf Einrichtung .

    2. Erweitern System Klicken Sie auf Single Sign-on (SSO).

    3. Im Typ auswählen, wählen Sie den SSO-Typ aus, den Ihr Unternehmen verwendet.

    4. Scrollen Sie mit dem ausgewählten Typ nach unten und löschen Sie die Aktivieren aktivieren.

    5. Klicken Sie auf Speichern.

  2. Geben Sie in der Adressleiste eines Browsers den folgenden API-Aufruf ein:

    <domain>.my.workfront.com/attask/api/v7.0/user?action=generateApiKey&username= ​Benutzername​ &password= ​password**&method=PUT

    Ersetzen <domain> mit Ihrem Workfront-Domänennamen sowie Benutzernamen und Kennwort mit den Workfront-Anmeldedaten des Benutzers.

  3. (Bedingt) Aktivieren Sie die Option, für die eine SSO-Authentifizierung erforderlich ist, wenn Sie sie in Schritt 1 deaktiviert haben.

    1. Klicken Sie auf Hauptmenü icon Klicken Sie oben rechts in Adobe Workfront auf Einrichtung .

    2. Erweitern System Klicken Sie auf Single Sign-on (SSO).

    3. Wählen Sie Ihre SSO-Methode im Typ aus.

    4. Aktivieren Sie das Kontrollkästchen, für das eine SSO-Authentifizierung erforderlich ist.

Konfigurieren, wann API-Schlüssel ablaufen

Sie können API-Schlüssel so konfigurieren, dass sie für alle Benutzer in Ihrem System ablaufen. Wenn der API-Schlüssel eines Benutzers abläuft, muss der Benutzer sich erneut bei allen Anwendungen authentifizieren, die die Workfront-API für den Zugriff auf Workfront verwenden. Sie können die Häufigkeit ändern, mit der die API-Schlüssel ablaufen. Sie können auch konfigurieren, ob API-Schlüssel ablaufen, wenn das Kennwort eines Benutzers abläuft.

  1. Klicken Sie auf Hauptmenü icon Klicken Sie oben rechts in Adobe Workfront auf Einrichtung .

  2. Klicks System > Kundeninformationen.

  3. Im API-Schlüsseleinstellungen im Nach Erstellung, API-Schlüssel laufen in ab in der Dropdown-Liste den Zeitrahmen auswählen, in dem die API-Schlüssel ablaufen sollen.

    Wenn Sie diese Option ändern, beginnt der neue Zeitrahmen mit dem Zeitpunkt, zu dem Sie die Änderung vorgenommen haben. Wenn Sie diese Option beispielsweise von 1 Monat nach 6 Monate festgelegt ist, laufen die API-Schlüssel 6 Monate nach der Änderung ab.

    Standardmäßig laufen API-Schlüssel jeden Monat ab.

  4. Um API-Schlüssel zu konfigurieren, die zum Zeitpunkt des Ablaufs der Passwörter der Benutzer ablaufen, wählen Sie Entfernen Sie den API-Schlüssel, wenn das Kennwort eines Benutzers abläuft.

    Standardmäßig ist diese Option nicht ausgewählt.

    Informationen zum Konfigurieren von ablaufenden Benutzerkennwörtern finden Sie unter Systemsicherheitsvoreinstellungen konfigurieren.

  5. Klicken Sie auf Speichern.

Entfernen Sie die API-Schlüssel für alle Benutzer

Wenn Sie wegen einer bestimmten Sicherheitsverletzung in Bezug auf Ihr Workfront-System besorgt sind, können Sie API-Schlüssel gleichzeitig für alle Benutzer entfernen.

IMPORTANT
Durch das Entfernen der API-Schlüssel für alle Benutzer werden ALLE API-Schlüssel für alle Benutzer im System ungültig. Dadurch schlagen all Ihre Integrationen in Workfront fehl, bis Sie einen neuen API-Schlüssel in Workfront generieren und alle Ihre Integrationen aktualisieren.

  1. Klicken Sie auf Hauptmenü icon Klicken Sie oben rechts in Adobe Workfront auf Einrichtung .

  2. Erweitern System Klicken Sie auf Kundeninformationen.

  3. Im API-Schlüsseleinstellungen Bereich, klicken Sie Entfernen aller API-Schlüssel Klicken Sie auf Entfernen Alle.

Einschränken von API-Anmeldungen mit einem X.509-Zertifikat

IMPORTANT
Das in diesem Abschnitt beschriebene Verfahren gilt nur für Organisationen, die noch nicht in die Adobe Business Platform integriert wurden. Die Anmeldung bei Workfront über die Workfront-API ist nicht verfügbar, wenn Ihr Unternehmen in die Adobe Business Platform integriert wurde.
Eine Liste der Verfahren, die je nachdem, ob Ihr Unternehmen in die Adobe Business Platform integriert wurde, unterschiedlich sind, finden Sie unter Plattformbasierte Verwaltungsunterschiede (Adobe Workfront/Adobe Business Platform).

Drittanbieteranwendungen können über die API mit Workfront kommunizieren. Um die Sicherheit Ihrer Workfront-Site zu erhöhen, können Sie Workfront so konfigurieren, dass API-Anmeldeanfragen eingeschränkt werden, indem Sie ein X.509-Zertifikat in Workfront hochladen. Nach der Aktivierung müssen alle Anmeldeanfragen über die API ein Client-Zertifikat zusätzlich zu Benutzername und Kennwort enthalten.

NOTE
Dies ist nicht verfügbar, wenn die Workfront-Instanz Ihres Unternehmens mit Adobe IMS aktiviert ist. Wenden Sie sich an Ihren Netzwerk- oder IT-Administrator, wenn Sie weitere Informationen benötigen.

Abrufen des X.509-Zertifikats obtain-the-x-509-certificate

Besorgen Sie sich ein gültiges X.509-Zertifikat von einer vertrauenswürdigen Zertifizierungsstelle (z. B. Verisign) und platzieren Sie es an einem temporären Speicherort auf Ihrer Workstation.

Hochladen des Zertifikats in Workfront upload-the-certificate-to-workfront

Nachdem Sie das X.509-Zertifikat von Ihrer Zertifizierungsstelle erhalten haben, müssen Sie es in Workfront hochladen.

  1. Klicken Sie auf Hauptmenü icon Klicken Sie oben rechts in Adobe Workfront auf Einrichtung .

  2. Erweitern System Klicken Sie auf Kundeninformationen.

  3. Im API-Schlüsseleinstellungen Bereich, auswählen X.509-Zertifikat aktivieren.

  4. Suchen Sie auf Ihrer Workstation das zuvor heruntergeladene X.509-Zertifikat und wählen Sie es aus.

  5. (Optional) Klicken Sie auf Details anzeigen neben dem Zertifikatnamen, um die folgenden Details zum Zertifikat anzuzeigen:

    • Allgemeiner Antragstellername
    • Organisation des Antragstellenden
    • Organisationseinheit des Antragstellenden
    • Allgemeiner Ausstellername
    • Organisation des Zertifikatausstellers
    • Organisationseinheit des Zertifikatausstellers
    • Seriennummer
    • Ausstellungsdatum
    • Ablaufdatum

  6. Klicken Sie auf Speichern.

Überprüfen, ob API-Anmeldeaufrufe eingeschränkt sind verify-api-login-calls-are-restricted

Führen Sie vor dem Konfigurieren Ihrer Workfront-Instanz, für die ein X.509-Zertifikat erforderlich ist, eine API-Anfrage an die /login Endpunkt mit gültigen Benutzernamen- und Kennwortparametern. Sie erhalten eine 200-Antwort, die eine sessionID enthält.

Nachdem Sie das X.509-Zertifikat über die Kundeninformationsseite in Ihrer Workfront-Instanz zur Anforderung gemacht haben, führen Sie einen weiteren Anmeldeversuch durch. Diesmal erhalten Sie eine 500-Fehlerantwort mit der folgenden Meldung: "Nicht vertrauenswürdige Anfrage. Wenden Sie sich an Ihren Systemadministrator und hängen Sie ein Zertifikat an."

Nachdem Sie bestätigt haben, dass das X.509-Zertifikat erforderlich ist, führen Sie dieselbe Anmeldeanfrage mit einem zusätzlichen Parameter für apiCertificate durch, der auf den Wert Ihres Zertifikats festgelegt ist. Wenn dieser Vorgang korrekt ausgeführt wurde, erhalten Sie eine 200-Antwort, die eine gültige sessionID enthält.

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