Dokumentation Workfront Användarhandbok om Workfront

Konfigurera och använda organisationens anpassade OAuth 2-program med hjälp av ett auktoriseringskodsflöde

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

Ämnen:

Skapat för:

Utvecklare

Om du vill integrera med Workfront och tillåta klientappen att kommunicera med Workfront å användarens vägnar måste du:

Skapa ett OAuth2-program
Konfigurera tredjepartsprogrammet
Länk till sidan Autentisera för dina användare
Konfigurera auktoriseringskodflöde: Användare loggar in på Workfront-instansen och godkänner att klientprogrammet tillåter att de ansluter till Workfront för deras räkning. Därför får du en auktoriseringskod som du byter ut med åtkomst- och uppdateringstokens.
Konfigurera uppdateringstokenflöde: I det här flödet använder du uppdateringstoken för att hämta en ny åtkomsttoken när den gamla har upphört att gälla.

Skapa ett OAuth2-program

Instruktioner om hur du skapar OAuth2-programmet finns i Skapa ett OAuth2-program med användarreferenser (Authorization code flow) i Skapa OAuth2-program för Workfront-integreringar (på engelska).

NOTE

Du kan ha upp till totalt tio OAuth2-program samtidigt.

Länk till sidan Autentisera för dina användare

Dina användare måste logga in för att godkänna integreringen på sina egna konton. Sidan som de ska godkänna har ett specifikt format, som beskrivs här. Använd den här informationen för att fastställa adressen till appens auktoriseringssida och förse användarna med den här adressen eller en länk till den.

Den fullständiga URL:en till din organisations domän. Exempel:

code language-none
`https://myorganization.my.workfront.com`

client_id: Detta är det klient-ID som genererades när du skapade OAuth2-appen i Workfront.
redirect_uri: Det här är den omdirigerings-URL som du angav när du skapade appen. Dina användare dirigeras till den här sidan när de har auktoriserat appen för sitt konto.
response_type: Detta måste ha värdet code.

URL:en för auktoriseringssidan är därför:

https://<URL of your organization's domain>/integrations/oauth2/authorize?client_id=<Your ClientID>&redirect_uri=<Your redirect URL>&response_type=code

NOTE

Vi rekommenderar att du skapar en knapp eller en annan länk som användarna kan klicka på för att dirigera till den här sidan.

Konfigurera tredjepartsprogrammet

Tredjepartsprogrammet kan kräva konfiguration. Följande tabell innehåller information om fält som kan behövas när du konfigurerar tredjepartsprogrammet.

Auktoriserings-URI

https://<the full URL of your organization's domain>/integrations/oauth2/authorize

Exempel: https://myorganization.my.workfront.com/integrations/oauth2/authorize

Token-URL

https://<the full URL of your organization's domain>/integrations/oauth2/api/v1/token

Exempel: https://myorganization.my.workfront.com/integrations/oauth2/api/v1/token

Omfång

Du behöver inte ange omfattningar.

Ställ in auktoriseringskodflöde

Så här loggar du in användare med OAuth2:

När användaren öppnar auktoriseringssidan dirigeras den om till inloggningssidan för Workfront så att användaren kan logga in på Workfront. Om användaren har en SSO-konfiguration öppnas identitetsleverantörens inloggningssida.

Om användaren redan är inloggad på Workfront i samma webbläsare, eller loggar in på Workfront utan fel, dirigeras användaren om till godkännandeskärmen:
Om användaren tillåter åtkomst omdirigeras sidan till redirect_url. Omdirigeringen måste innehålla följande frågeparametrar:

code: Auktoriseringskoden som krävs för att hämta åtkomst-/uppdateringstoken.
domain: Din organisations domän. Exempel: i myorganization.my.workfront.com är domänen myorganization.

lane: begärans intervall. Exempel: i myorganization.preview.workfront.com är körfältet preview.

note important
IMPORTANT
`code` är bara giltigt i 2 minuter. Därför måste du hämta uppdaterings- och åtkomsttoken inom den tiden.

När du har en kod kan du begära uppdatering och åtkomst till tokens genom att skicka koden tillsammans med klientprogrammets autentiseringsuppgifter till slutpunkten /integrations/oauth2/api/v1/token.

Den fullständiga URL:en för tokenbegäran är

code language-none
`https://<URL of your organization's domain></span>/integrations/oauth2/api/v1/token`

Exempel: Exempel på CURL-anrop till tokenslutpunkt:

Exempel 1

code language-none

code language-none
`curl --location --request POST '<workfront host>/integrations/oauth2/api/v1/token' \ --header 'Authorization: Basic <base64(client_id:client_secret)>' \ --header 'Content-Type: application/json' \ --data-raw '{ "code": "<code>", "grant_type": "authorization_code", "redirect_uri": "<redirect_url>" }'`

   curl --location --request POST '**<workfront host>**/integrations/oauth2/api/v1/token' \
   --header 'Authorization: Basic **<base64(client_id:client_secret)>**' \
   --header 'Content-Type: application/json' \
   --data-raw '{
   "code": "**<code>**",
   "grant_type": "**authorization_code**",
   "redirect_uri": "**<redirect_url>**"
   }'

Exempel 2

code language-none

code language-none
`curl --location --request POST '<workfront host>/integrations/oauth2/api/v1/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=authorization_code' \ --data-urlencode 'redirect_uri=<redirect_url>' \ --data-urlencode 'code=<code>' \ --data-urlencode 'client_id=<client_id>' \ --data-urlencode 'client_secret=<client_secret>'`

   curl --location --request POST '**<workfront host>**/integrations/oauth2/api/v1/token' \
   --header 'Content-Type: application/x-www-form-urlencoded' \
   --data-urlencode 'grant_type=**authorization_code**' \
   --data-urlencode 'redirect_uri=**<redirect_url>**' \
   --data-urlencode 'code=**<code>**' \
   --data-urlencode 'client_id=**<client_id>**' \
   --data-urlencode 'client_secret=**<client_secret>**'

note important
IMPORTANT
Klienthemligheten genererades när appen registrerades i Workfront. Du bör lagra den på en säker plats, eftersom den inte kan återställas om den förloras.

När alla skickade parametrar är korrekta returnerar tokenslutpunkten följande nyttolast:

code language-none
`{ "token_type": "sessionID", "access_token": "string", // the value of sessionID "refresh_token": "string", "expires_in": 0, "wid": "string" }`

Åtkomsttoken är samma som sessionID, och den upphör att gälla på samma sätt som vanlig sessionID

note important
IMPORTANT
Lagra uppdateringstoken på en säker plats. Du behöver den för att få en ny uppdateringstoken när den gamla har gått ut. Workfront lagrar inte din uppdateringstoken.

Nu när du har en åtkomsttoken kan du göra API-anrop till Workfront

code language-none
`curl --request GET 'https://<workfront host>/attask/api/v14.0/proj/search \ --header 'sessionID: <access_token>'`

Konfigurera åtkomsttoken för uppdatering

För att uppdatera access_token måste vi göra ett POST-anrop till tokenslutpunkten igen. Den här gången skickar vi en annan formulärdata enligt följande:

curl --location --request POST '<workfront host>/integrations/oauth2/api/v1/token' \
--header 'Authorization: Basic <base64(client_id:client_secret)>' \
--header 'Content-Type: application/json' \
--data-raw '{
   "grant_type": "refresh_token",
   "refresh_token": "<refresh_token>"
}'

###### OR

curl --location --request POST '<workfront host>/integrations/oauth2/api/v1/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'redirect_uri=<redirect_url>' \
--data-urlencode 'refresh_token=<refresh_token>' \
--data-urlencode 'client_id=<client_id>' \
--data-urlencode 'client_secret=<client_secret>'

Det returnerar följande resultat:

{
  "token_type": "sessionID",
  "access_token": "string", // the value of sessionID
  "refresh_token": "string",
  "expires_in": 0,
  "wid": "string"
}

Återigen är åtkomsttoken sessionID som kan användas för att göra en API-begäran till Workfront.

recommendation-more-help

5f00cc6b-2202-40d6-bcd0-3ee0c2316b43