DokumentationWorkfrontAnvändarhandbok om Workfront

Hantera API-nycklar

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Administratör

För att minimera säkerhetsluckor i API:t kan Adobe Workfront-administratörer hantera de API-nycklar som används för att ge program åtkomst till Workfront för en användares räkning.

Du kan återställa eller ta bort den aktuella API-administratörens nyckel, konfigurera API-nycklar så att de upphör att gälla och ta bort API-nycklarna för alla användare.

Exempel på program som utnyttjar Workfront API är:

  • Dokumentintegrationer som Dropbox, Google Drive och Workfront DAM
  • Workfront mobilappar
IMPORTANT
När du återställer eller tar bort en API-nyckel måste alla program som använder Workfront API och autentiserar till Workfront via denna API-nyckel konfigureras om för att få tillgång till Workfront igen.

Åtkomstkrav

Du måste ha följande åtkomst för att kunna utföra stegen i den här artikeln:

Adobe Workfront
Alla
Adobe Workfront-licens
Plan
Konfigurationer på åtkomstnivå

Du måste vara Workfront-administratör.

Obs! Om du fortfarande inte har åtkomst frågar du Workfront-administratören om de har angett ytterligare begränsningar för din åtkomstnivå. Mer information om hur en Workfront-administratör kan ändra åtkomstnivån finns i Skapa eller ändra anpassade åtkomstnivåer.

Workfront API-nycklar

Varje användare i Workfront har en unik API-nyckel. Nyckeln genereras per användare när användaren öppnar en integrering som utnyttjar Workfront API (t.ex. Workfront mobilapp eller dokumentintegrering).

NOTE
API-nycklar som du genererar i produktionsmiljön kopieras till förhandsvisningsmiljön under veckouppdateringen. Alla API-nycklar som du genererar i förhandsvisningsmiljön skrivs över med dina produktions-API-nycklar under veckouppdateringen.

Workfront-administratörer har också en unik API-nyckel. När ett program använder en API-administratörsnyckel för att komma åt Workfront har programmet administratörsåtkomst till Workfront.

Hantera en administratör-API-nyckel

Du kan generera, återställa eller ta bort API-nyckeln för ditt administratörsanvändarkonto.

NOTE
Du kan också generera en API-nyckel via API:t. Mer information finns i avsnittet om API för händelseprenumeration i API:t för händelseprenumeration.

  1. Klicka på ikonen Huvudmeny i det övre högra hörnet av Adobe Workfront och klicka sedan på Konfigurera .

  2. Klicka på System > Kundinformation.

  3. (Villkorligt) Utför någon av följande åtgärder:

    Så här genererar du en API-nyckel: Klicka på Generera API-nyckel i avsnittet API-nyckelinställningar.

    eller
    Så här återställer du en API-nyckel: I avsnittet API-nyckelinställningar klickar du på Återställ och sedan på Återställ.

    eller

    Så här tar du bort API-nyckeln: Klicka på Ta bort i avsnittet API-nyckelinställningar och sedan på Ta bort.

Generera en API-nyckel för icke-admin-användare

Du kan generera och hantera API-nycklar för användare i andra roller än Workfront-administratören.

NOTE
Detta är inte tillgängligt om din organisations Workfront-instans har aktiverats med Adobe IMS. Kontakta nätverks- eller IT-administratören om du behöver mer information.

  1. (Villkorligt) Om din organisation använder enkel inloggning (SSO), kan du tillfälligt inaktivera alternativet som kräver SSO-autentisering.

    1. Klicka på ikonen Huvudmeny i det övre högra hörnet av Adobe Workfront och klicka sedan på Konfigurera .

    2. Expandera System och klicka sedan på Enkel inloggning (SSO).

    3. I fältet Typ väljer du den typ av enkel inloggning som din organisation använder.

    4. När typen är markerad rullar du nedåt och avmarkerar kryssrutan Aktivera.

    5. Klicka på Spara.

  2. Ange följande API-anrop i adressfältet i en webbläsare:

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

    Ersätt <domain> med ditt Workfront-domännamn och användarnamn och lösenord med användarens Workfront-autentiseringsuppgifter.

  3. (Villkorligt) Aktivera alternativet som kräver SSO-autentisering om du inaktiverade det i steg 1.

    1. Klicka på ikonen Huvudmeny i det övre högra hörnet av Adobe Workfront och klicka sedan på Konfigurera .

    2. Expandera System och klicka sedan på Enkel inloggning (SSO).

    3. Välj din SSO-metod i listrutan Typ.

    4. Markera kryssrutan som kräver SSO-autentisering.

Konfigurera när API-nycklar upphör att gälla

Du kan konfigurera API-nycklar så att de upphör att gälla för alla användare i systemet. När API-nyckeln för en användare upphör att gälla måste användaren autentisera på nytt för alla program som använder Workfront API för att få åtkomst till Workfront. Du kan ändra hur ofta API-nycklarna förfaller. Du kan också konfigurera om API-nycklar ska förfalla när lösenordet för en användare förfaller.

  1. Klicka på ikonen Huvudmeny i det övre högra hörnet av Adobe Workfront och klicka sedan på Konfigurera .

  2. Klicka på System > Kundinformation.

  3. I området API-nyckelinställningar, i listrutan Efter skapande, förfaller API-nycklar i, väljer du den tidsram som du vill att API-nycklarna ska förfalla.

    När du ändrar det här alternativet börjar den nya tidsramen från den tidpunkt du gjorde ändringen. Om du till exempel ändrar det här alternativet från 1 månad till 6 månader förfaller API-nycklarna sex månader från den tidpunkt du gör ändringen.

    API-nycklar förfaller som standard varje månad.

  4. Om du vill konfigurera API-nycklar så att de förfaller när användarens lösenord förfaller väljer du Ta bort API-nyckel när användarens lösenord förfaller.

    Som standard är det här alternativet inte markerat.

    Mer information om hur du konfigurerar användarlösenord så att de upphör att gälla finns i Konfigurera systemsäkerhetsinställningar.

  5. Klicka på Spara.

Ta bort API-nycklarna för alla användare

Om du är orolig för en viss säkerhetsöverträdelse i ditt Workfront-system kan du ta bort API-nycklar samtidigt för alla användare.

IMPORTANT
Om du tar bort API-nycklar för alla användare blir ALLA API-nycklar ogiltiga för alla användare i systemet. Den här åtgärden gör att alla integreringar i Workfront misslyckas tills du genererar en ny API-nyckel i Workfront och uppdaterar alla integreringar.

  1. Klicka på ikonen Huvudmeny i det övre högra hörnet av Adobe Workfront och klicka sedan på Konfigurera .

  2. Expandera System och klicka sedan på Kundinformation.

  3. I området API-nyckelinställningar klickar du på Ta bort alla API-nycklar och sedan på Ta bort alla.

Begränsa API-inloggningar med ett X.509-certifikat

IMPORTANT
Det förfarande som beskrivs i detta avsnitt gäller endast organisationer som ännu inte har anslutit sig till Adobe Business Platform. Det går inte att logga in på Workfront via Workfront API om din organisation har anslutit sig till Adobe Business Platform.
En lista över procedurer som skiljer sig åt beroende på om din organisation har anslutit sig till Adobe Business Platform finns i Plattformsbaserade administrationsskillnader (Adobe Workfront/Adobe Business Platform).

Tredjepartsprogram kan kommunicera med Workfront via API:t. Om du vill öka säkerheten på din Workfront-webbplats kan du konfigurera Workfront att begränsa API-inloggningsbegäranden genom att överföra ett X.509-certifikat till Workfront. När den är aktiverad måste alla inloggningsbegäranden via API:t innehålla ett klientcertifikat förutom användarnamn och lösenord.

NOTE
Detta är inte tillgängligt om din organisations Workfront-instans har aktiverats med Adobe IMS. Kontakta nätverks- eller IT-administratören om du behöver mer information.

Hämta X.509-certifikatet obtain-the-x-509-certificate

Hämta ett giltigt X.509-certifikat från en betrodd certifikatutfärdare (till exempel Verisign) och placera det på en tillfällig plats på din arbetsstation.

Överför certifikatet till Workfront upload-the-certificate-to-workfront

När du har fått X.509-certifikatet från din certifikatutfärdare måste du överföra det till Workfront.

  1. Klicka på ikonen Huvudmeny i det övre högra hörnet av Adobe Workfront och klicka sedan på Konfigurera .

  2. Expandera System och klicka sedan på Kundinformation.

  3. I området API-nyckelinställningar väljer du Aktivera X.509-certifikat.

  4. På din arbetsstation bläddrar du till och väljer det X.509-certifikat som du har hämtat tidigare.

  5. (Valfritt) Klicka på Visa information bredvid certifikatnamnet om du vill visa följande information om certifikatet:

    • Ämnesnamn
    • Ämnesorganisation
    • Enhet för ämnesorganisation
    • Namn på utfärdare
    • Utfärdarorganisation
    • Utfärdarorganisationsenhet
    • Serienummer
    • Utgivningsdatum
    • Förfallodatum

  6. Klicka på Spara.

Verifiera att API-inloggningsanrop är begränsade verify-api-login-calls-are-restricted

Innan du konfigurerar din instans av Workfront så att den kräver ett X.509-certifikat utför du en API-begäran till /login-slutpunkten med hjälp av giltiga parametrar för användarnamn och lösenord. Du får ett 200-svar som innehåller ett sessions-ID.

När du har gjort X.509-certifikatet till ett krav via kundinformationssidan i din instans av Workfront, gör du ett nytt inloggningsförsök. Den här gången får du ett 500-felsvar med följande meddelande:"Untrusted request request. Kontakta systemadministratören och bifoga certifikatet."

När du har bekräftat att X.509-certifikatet krävs utför du samma inloggningsbegäran med en extra parameter för apiCertificate som är inställd på värdet för ditt certifikat. Om den här åtgärden utfördes korrekt får du ett 200-svar som innehåller ett giltigt sessions-ID.

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