Skapa OAuth2-program för Workfront integreringar
Som Adobe Workfront-administratör kan du skapa OAuth2-program för din instans av Workfront, som ger andra program åtkomst till Workfront. Dina användare kan sedan ge dessa andra program behörighet att komma åt sina Workfront-data. På så sätt kan du integrera med valfria program, inklusive egna, interna tillämpningar.
När du skapar ett OAuth2-program genererar du ett klient-ID och en klienthemlighet. Dina användare kan sedan använda klient-ID i API-anrop för att integrera med det program du har skapat.
- Instruktioner om hur du konfigurerar och använder OAuth2-programmet med inloggningsuppgifter (auktoriseringskodflöde) finns i Konfigurera och använda organisationens anpassade OAuth 2-program med auktoriseringskodflöde.
- Instruktioner om hur du konfigurerar och använder OAuth2-programmet med serverautentisering (JWT-flöde) finns i Konfigurera och använda organisationens anpassade OAuth 2-program med JWT-flöde.
- Instruktioner om hur du konfigurerar och använder OAuth2-programmet med PKCE finns i Konfigurera och använda organisationens anpassade OAuth 2-program med PKCE-flöde.
Åtkomstkrav
Du måste ha följande åtkomst för att kunna utföra stegen i den här artikeln:
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront plan* | Alla |
| Adobe Workfront licens* |
Nytt: Standard eller Aktuell:Plan |
| Konfigurationer på åtkomstnivå* | Du måste vara en Workfront-administratör. |
*Kontakta Workfront-administratören om du vill ta reda på vilken plan, licenstyp eller åtkomst du har.
OAuth2 - översikt
Tänk dig att ett program måste hämta viss specifik information från Workfront. Ett program som begär information kallas för en klient. I det här exemplet är klientnamnet ClientApp. ClientApp behöver åtkomst till en viss användares information och måste därför ha åtkomst till Workfront som den användaren. Om användaren ger ClientApp sitt användarnamn och lösenord kan ClientApp komma åt alla data som användaren har åtkomst till. Det här är en säkerhetsrisk eftersom ClientApp bara behöver en liten, specifik uppsättning information.
När du skapar en OAuth2-app för ClientApp talar du i stort sett om för Workfront att ClientApp har åtkomst till Workfront, men bara om den användare vars konto ClientApp har åtkomst ger åtkomst till programmet.
Skapa ett OAuth2-program
När du skapar ett OAuth2-program ska du välja den typ av program som bäst uppfyller integreringens behov.
Passar bäst för CLI, daemon och skript som körs på servern
Exempel:
-
Shell
-
Python
Passar bäst för mobil- och enkelsidiga webbapplikationer
Exempel:
-
Javascript
-
Angular
-
React
-
Vue
Passar bäst för program på serversidan som hanterar autentiseringsuppgifter och tokens på servern
Exempel:
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
Skapa ett OAuth2-program med serverautentisering (JWT-flöde) create-an-oauth2-application-using-server-authentication-jwt-flow
-
Klicka på ikonen Main Menu
-
Klicka på System i den vänstra navigeringspanelen och välj sedan OAuth2 Applications.
-
Klicka på Create app integration.
Rutan Nytt OAuth2-program visas. -
Välj Machine to Machine Application i rutan Nytt OAuth2-program.
-
Ange ett namn för det nya programmet, till exempel Workfront för ClientApp.
-
Klicka på Create.
-
Fyll i fälten för den nya appen.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header Client ID Det här fältet genereras automatiskt. Client secret Det här fältet genereras automatiskt
VIKTIGT:
Kopiera innehållet i det här fältet till en annan säker fil innan du stänger den här sidan. Du kommer inte att kunna se den här hemliga nyckeln igen.
Om du förlorar den här nyckeln tar du bort den och skapar en klienthemlighet.
-
Klicka på ikonen Delete
-
Klicka på Add client secret om du vill skapa en ny klienthemlighet.
Public Keys Server-till-server-appar använder offentliga och privata nycklar för autentisering. Gör något av följande:
-
Klicka på Add a public key och ange den offentliga nyckeln från det andra programmet.
-
Klicka på Generate a public/private keypair och dela sedan den offentliga nyckeln med det andra programmet.
Name Det här är samma namn som du gav appen. Det här fältet får inte vara tomt. Description Ange en beskrivning för integreringen. -
-
Klicka på Save.
Instruktioner om hur du konfigurerar och använder OAuth2-programmet med inloggningsuppgifter (auktoriseringskodflöde) finns i Konfigurera och använda organisationens anpassade OAuth 2-program med JWT-flöde.
Skapa ett OAuth2-program med användarens inloggningsuppgifter (kodflöde för auktorisering) create-an-oauth2-application-using-user-credentials-authorization-code-flow
-
Klicka på ikonen Main Menu
-
Klicka på System i den vänstra navigeringspanelen och välj sedan OAuth2 Applications.
-
Klicka på Create app integration.
Nytt OAuth2-program visas.
-
Välj Web Application i rutan Nytt OAuth2-program.
-
Ange ett namn för det nya OAuth2-programmet, till exempel Workfront för ClientApp.
-
Klicka på Create.
-
Fyll i fälten för den nya appen.
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 Det här fältet genereras automatiskt. Client secret Det här fältet genereras automatiskt
VIKTIGT:
Kopiera innehållet i det här fältet till en annan säker fil innan du stänger den här sidan. Du kommer inte att kunna se den här hemliga nyckeln igen.
Om du förlorar den här nyckeln tar du bort den och skapar en klienthemlighet.
-
Klicka på ikonen Delete
-
Klicka på Add client secret om du vill skapa en ny klienthemlighet.
Redirect URLs Användare omdirigeras till den här sökvägen efter att de har autentiserats med Workfront. Refresh token rotation Aktivera det här alternativet om du vill att en ny uppdateringstoken ska utfärdas när uppdateringstoken används. Programmet måste lagra den nya uppdateringstoken efter varje uppdatering. Absolute refresh token expiration Välj hur lång tid du vill att en uppdateringstoken ska finnas innan den upphör att gälla. När den upphör att gälla måste användarna logga in på integreringen igen. Välj No expiration om du inte vill att uppdateringstoken ska förfalla. Inaktivitetsuppdateringstoken förfaller Välj efter hur lång tid, om användaren inte har varit aktiv i systemet, deras uppdateringstoken förfaller.
Om till exempel inaktivitetens utgångsdatum för uppdateringstoken är sex månader och användaren inte loggar in på sex månader, upphör uppdateringstoken att gälla även om den absoluta utgångstiden för uppdateringstoken kan anges längre.
Logo Du kan lägga till en logotyp för att göra appen mer identifierbar. Name Det här är samma namn som du gav appen. Det här fältet får inte vara tomt. Description Ange en beskrivning för integreringen. App Description URL Det kan vara en länk till en"Om oss"-sida eller en sida med mer information om integreringen. -
-
Klicka på Save.
Instruktioner om hur du konfigurerar och använder OAuth2-programmet med inloggningsuppgifter (auktoriseringskodflöde) finns i Konfigurera och använda organisationens anpassade OAuth 2-program med auktoriseringskodflöde.
Skapa ett ensidigt OAuth2-webbprogram med PKCE create-an-oauth2-single-page-web-application-using-pkce
-
Klicka på ikonen Main Menu
-
Klicka på System i den vänstra navigeringspanelen och välj sedan OAuth2 Applications.
-
Klicka på Create app integration.
Rutan Nytt OAuth2-program visas.
-
Välj Single Page Web Application i rutan Nytt OAuth2-program.
-
Ange ett namn för det nya OAuth2-programmet, till exempel Workfront för ClientApp.
-
Klicka på Create.
-
Fyll i fälten för den nya appen.
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 Det här fältet genereras automatiskt. Redirect URLs Användare omdirigeras till den här sökvägen när de har autentiserats med Workfront. Rotate refresh token every time it is used Aktivera det här alternativet om du vill att en ny uppdateringstoken ska utfärdas när uppdateringstoken används. Programmet måste lagra den nya uppdateringstoken efter varje uppdatering. Absolute expiration Välj hur lång tid du vill att en uppdateringstoken ska finnas innan den upphör att gälla. När den upphör att gälla måste användarna logga in på integreringen igen. Välj No expiration om du inte vill att uppdateringstoken ska förfalla. Inactivity expiration Välj efter hur lång tid, om användaren inte har varit aktiv i systemet, deras uppdateringstoken förfaller.
Om till exempel inaktivitetens utgångsdatum för uppdateringstoken är sex månader och användaren inte loggar in på sex månader, upphör uppdateringstoken att gälla även om den absoluta utgångstiden för uppdateringstoken kan anges längre.
Logo Du kan lägga till en logotyp för att göra appen mer identifierbar. Name Det här är samma namn som du gav appen. Det här fältet får inte vara tomt. Description Ange en beskrivning för integreringen. Developer name Detta är namnet på den utvecklare som konfigurerar OAuth2-programmet. Developer email address Detta är e-postadressen till den utvecklare som konfigurerar OAuth2-programmet. Privacy policy URL Det här är länken till den plats där din organisation lagrar integritetspolicyn. -
Klicka på Save.
Konfigurera och använda det skapade OAuth2-programmet
Ytterligare konfiguration och användning av det skapade OAuth2-programmet kräver viss teknisk kunskap, inklusive API-anrop.
- Instruktioner om hur du konfigurerar och använder OAuth2-programmet med inloggningsuppgifter (auktoriseringskodflöde) finns i Konfigurera och använda organisationens anpassade OAuth 2-program med auktoriseringskodflöde.
- Instruktioner om hur du konfigurerar och använder OAuth2-programmet med serverautentisering (JWT-flöde) finns i Konfigurera och använda organisationens anpassade OAuth 2-program med JWT-flöde.
- Instruktioner om hur du konfigurerar och använder OAuth2-programmet med PKCE finns i Konfigurera och använda organisationens anpassade OAuth 2-program med PKCE-flöde.
OAuth2-processer för auktoriseringskodflöde
Auktorisera med en auktoriseringskod och åtkomsttoken authorizing-with-an-authorization-code-and-access-token
-
ClientApp behöver viss information från Workfront, så den skickar en begäran till Workfront API
/authorize-slutpunkten. Begäran innehåller response_typecodesom anger att begäran ska returnera en auktoriseringskod. -
Detta utlöser Workfront för att skicka en autentiseringsfråga till användaren. Användaren kan ange sina autentiseringsuppgifter i uppmaningen, som ger Workfront behörighet att kommunicera med ClientApp. Om användaren redan är inloggad på Workfront kan det här steget hoppas över.
-
API:t Workfront skickar en auktoriseringskod till ClientApp.
-
ClientApp skickar följande information i en begäran till Workfront API
/tokenslutpunkt:- Auktoriseringskoden som skickas till ClientApp i steg 3. Detta identifierar den specifika instansen av användarbehörighet.
- Klienthemligheten som genererades när du konfigurerade ClientApp OAuth2-appen i Workfront. Detta gör att Workfront kan veta att begäran kommer från ClientApp.
-
Om auktoriseringskoden och klienthemligheten är korrekta skickar Workfront en åtkomsttoken till ClientApp. Denna åtkomsttoken skickas direkt från Workfront till ClientApp och kan inte visas, kopieras eller användas av andra användar- eller klientprogram.
-
ClientApp skickar åtkomsttoken till Workfront tillsammans med den specifika begäran om information.
-
Eftersom åtkomsttoken är korrekt skickar Workfront informationen till ClientApp.
Uppdaterar åtkomsttoken
Av säkerhetsskäl upphör åtkomsttoken att gälla efter en kort tid. OAuth2 använder uppdateringstoken för att få nya åtkomsttoken utan att behöva ange autentiseringsuppgifter varje gång. Uppdateringstoken lagras av klienten.
Processen för att hämta en uppdateringstoken är densamma som proceduren som beskrivs i avsnittet Autentisering med en auktoriseringskod och åtkomsttoken. Begäran för auktoriseringskoden innehåller scopet offline_access, som anger att begäran ska returnera en begärandetoken tillsammans med auktoriseringskoden.