OAuth2-toepassingen maken voor Workfront integratie
Als Adobe Workfront beheerder, kunt u toepassingen OAuth2 voor uw geval tot stand brengen van Workfront, die andere toepassingen toegang geven tot Workfront. Uw gebruikers kunnen deze andere toepassingen dan toestemming geven om hun Workfront gegevens. Op deze manier kunt u integreren met toepassingen van uw keuze, inclusief uw eigen interne toepassingen.
Wanneer u een OAuth2 toepassing, produceert u een identiteitskaart van de Cliënt en Geheime cliënt. Uw gebruikers kunnen de client-id vervolgens gebruiken in API-aanroepen om deze te integreren met de toepassing die u hebt gemaakt.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 met gebruikersgeloofsbrieven (de stroom van de vergunningscode), zie Vorm en gebruik de douane OAuth 2 van uw organisatie toepassingen gebruikend de stroom van de vergunningscode.
- Voor instructies over het vormen van en het gebruiken van de toepassing OAuth2 gebruikend serverauthentificatie (stroom JWT), zie Configureer en gebruik de aangepaste OAuth 2-toepassingen van uw organisatie met behulp van JWT-flow.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 die PKCE gebruikt, zie Configureer en gebruik de aangepaste OAuth 2-toepassingen van uw organisatie met PKCE-stroom.
Toegangsvereisten
U moet de volgende toegang hebben om de stappen in dit artikel uit te voeren:
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront plan* | Alle |
| Adobe Workfront licentie* |
Nieuw: Standard of Huidige:Plan |
| Configuraties op toegangsniveau* | U moet een Workfront beheerder. |
*Neem contact op met uw Workfront beheerder.
OAuth2-overzicht
Stel dat een toepassing bepaalde specifieke informatie moet ophalen uit Workfront. Een toepassing die om informatie verzoekt wordt genoemd een cliënt. In dit voorbeeld is de naam van de client ClientApp. ClientApp heeft toegang tot de informatie van een bepaalde gebruiker nodig en moet daarom toegang krijgen tot Workfront als die gebruiker. Als uw gebruiker ClientApp hun gebruikersnaam en wachtwoord geeft, kon ClientApp tot alle gegevens toegang hebben die de gebruiker kan toegang hebben. Dit is een beveiligingsrisico, omdat ClientApp slechts een kleine, specifieke verzameling informatie nodig heeft.
Wanneer u een OAuth2-app voor ClientApp maakt, vertelt u Workfront dat ClientApp toegang heeft tot Workfront, maar alleen als de gebruiker wiens account ClientApp benadert, toestemming geeft voor de toegang.
Een OAuth2-toepassing maken
Wanneer u een OAuth2-toepassing maakt, kiest u het type toepassing dat het beste aan de behoeften van uw integratie voldoet.
Meest geschikt voor CLI's, daemons of scripts die op uw server worden uitgevoerd
Voorbeelden:
-
Shell
-
Python
Meest geschikt voor mobiele of webtoepassingen met één pagina
Voorbeelden:
-
Javascript
-
Angular
-
React
-
Vue
Meest geschikt voor servertoepassingen die aanmeldingsgegevens en tokens op de server verwerken
Voorbeelden:
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
Een OAuth2-toepassing maken met serververificatie (JWT-stroom) create-an-oauth2-application-using-server-authentication-jwt-flow
-
Klik op de knop Main Menu pictogram
-
Klik in het linkernavigatievenster op System selecteert u vervolgens OAuth2 Applications.
-
Klikken Create app integration.
De Nieuwe OAuth2-toepassing wordt weergegeven. -
In de Nieuwe OAuth2-toepassing vak, selecteren Machine to Machine Application.
-
Voer een naam in voor de nieuwe toepassing, bijvoorbeeld "Workfront voor ClientApp."
-
Klik op Create.
-
Vul de velden voor de nieuwe app in.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header Client ID Dit veld wordt automatisch gegenereerd. Client secret Dit veld wordt automatisch gegenereerd
BELANGRIJK:
Kopieer de inhoud van dit veld naar een ander beveiligd bestand voordat u deze pagina sluit. Je kunt deze geheime sleutel niet meer zien.
Als u deze sleutel verliest, schrap het en creeer een Geheim van de Cliënt.
-
Klik op de knop Delete pictogram
-
Klikken Add client secret om een nieuw Geheim van de Cliënt te produceren.
Public Keys Server-naar-server-apps gebruiken openbare en persoonlijke sleutels voor verificatie. Voer een van de volgende handelingen uit:
-
Klikken Add a public key en voert u de openbare sleutel in vanuit de andere toepassing.
-
Klikken Generate a public/private keypair deelt u vervolgens de openbare sleutel met de andere toepassing.
Name Dit is dezelfde naam die u de app hebt gegeven. Dit veld mag niet leeg zijn. Description Voer een beschrijving in voor de integratie. -
-
Klik op Save.
Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 met gebruikersgeloofsbrieven (de stroom van de vergunningscode), zie Configureer en gebruik de aangepaste OAuth 2-toepassingen van uw organisatie met behulp van JWT-flow.
Een OAuth2-toepassing maken met gebruikersgegevens (doorloop machtigingscode) create-an-oauth2-application-using-user-credentials-authorization-code-flow
-
Klik op de knop Main Menu pictogram
-
Klik in het linkernavigatievenster op System selecteert u vervolgens OAuth2 Applications.
-
Klik op Create app integration.
De Nieuwe OAuth2-toepassing worden weergegeven.
-
In de Nieuwe OAuth2-toepassing vak, selecteren Web Application.
-
Voer een naam in voor de nieuwe OAuth2-toepassing, bijvoorbeeld "Workfront voor ClientApp."
-
Klik op Create.
-
Vul de velden voor de nieuwe app in.
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 Dit veld wordt automatisch gegenereerd. Client secret Dit veld wordt automatisch gegenereerd
BELANGRIJK:
Kopieer de inhoud van dit veld naar een ander beveiligd bestand voordat u deze pagina sluit. Je kunt deze geheime sleutel niet meer zien.
Als u deze sleutel verliest, schrap het en creeer een Geheim van de Cliënt.
-
Klik op de knop Delete pictogram
-
Klikken Add client secret om een nieuw Geheim van de Cliënt te produceren.
Redirect URLs Gebruikers worden omgeleid naar dit pad nadat ze zijn geverifieerd met Workfront. Refresh token rotation Schakel deze optie in om een nieuw token voor vernieuwen uit te geven wanneer het token voor vernieuwen wordt gebruikt. Uw toepassing moet het nieuwe vernieuwingstoken opslaan na elke verfrissing. Absolute refresh token expiration Selecteer de hoeveelheid tijd dat u een vernieuwingstoken wilt bestaan alvorens het verloopt. Wanneer het verloopt, moeten uw gebruikers zich opnieuw aan de integratie aanmelden. Selecteren "No expiration" als u niet wilt dat het token vernieuwen verloopt. Vernieuwingstoken voor inactiviteit verlopen Selecteer de hoeveelheid tijd waarna, als de gebruiker niet in uw systeem actief is geweest, verfrist hun token verloopt.
Bijvoorbeeld, als de inactiviteit symbolische vervaldatum 6 maanden vernieuwt, en de gebruiker login niet zes maanden is, verfrist het token verloopt alhoewel de absolute verfrist symbolische vervaldatum voor langer kan worden geplaatst.
Logo U kunt een logo toevoegen om deze app beter te kunnen identificeren. Name Dit is dezelfde naam die u de app hebt gegeven. Dit veld mag niet leeg zijn. Description Voer een beschrijving in voor de integratie. App Description URL Dit kan een koppeling zijn naar een pagina "Over ons" of een pagina met meer informatie over de integratie. -
-
Klik op Save.
Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 met gebruikersgeloofsbrieven (de stroom van de vergunningscode), zie Vorm en gebruik de douane OAuth 2 van uw organisatie toepassingen gebruikend de stroom van de vergunningscode.
Een OAuth2-webtoepassing met één pagina maken met PKCE create-an-oauth2-single-page-web-application-using-pkce
-
Klik op de knop Main Menu pictogram
-
Klik in het linkernavigatievenster op System selecteert u vervolgens OAuth2 Applications.
-
Klik op Create app integration.
De Nieuwe OAuth2-toepassing wordt weergegeven.
-
In de Nieuwe OAuth2-toepassing vak, selecteren Single Page Web Application.
-
Voer een naam in voor de nieuwe OAuth2 , zoals "Workfront voor ClientApp."
-
Klik op Create.
-
Vul de velden voor de nieuwe app in.
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 Dit veld wordt automatisch gegenereerd. Redirect URLs Gebruikers worden omgeleid naar dit pad nadat ze zijn geverifieerd met Workfront. Rotate refresh token every time it is used Schakel deze optie in om een nieuw token voor vernieuwen uit te geven wanneer het token voor vernieuwen wordt gebruikt. Uw toepassing moet het nieuwe vernieuwingstoken opslaan na elke verfrissing. Absolute expiration Selecteer de hoeveelheid tijd u een vernieuwingstoken wenst te bestaan alvorens het verloopt. Wanneer het verloopt, moeten uw gebruikers zich opnieuw aan de integratie aanmelden. Selecteren "No expiration" als u niet wilt dat het token vernieuwen verloopt. Inactivity expiration Selecteer de hoeveelheid tijd waarna, als de gebruiker niet in uw systeem actief is geweest, verfrist hun token verloopt.
Bijvoorbeeld, als de inactiviteit symbolische vervaldatum 6 maanden vernieuwt, en de gebruiker login niet zes maanden is, verfrist het token verloopt alhoewel de absolute verfrist symbolische vervaldatum voor langer kan worden geplaatst.
Logo U kunt een logo toevoegen om deze app beter te kunnen identificeren. Name Dit is dezelfde naam die u de app hebt gegeven. Dit veld mag niet leeg zijn. Description Voer een beschrijving in voor de integratie. Developer name Dit is de naam van de ontwikkelaar die de OAuth2-toepassing instelt. Developer email address Dit is het e-mailadres van de ontwikkelaar die de OAuth2-toepassing instelt. Privacy policy URL Dit is de verbinding aan waar uw organisatie het privacybeleid opslaat. -
Klik op Save.
Vorm en gebruik de gecreeerde toepassing OAuth2
De verdere configuratie en het gebruik van de gecreeerde toepassing OAuth2 vereisen wat technische kennis, met inbegrip van API vraag.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 met gebruikersgeloofsbrieven (de stroom van de vergunningscode), zie Vorm en gebruik de douane OAuth 2 van uw organisatie toepassingen gebruikend de stroom van de vergunningscode.
- Voor instructies over het vormen van en het gebruiken van de toepassing OAuth2 gebruikend serverauthentificatie (stroom JWT), zie Configureer en gebruik de aangepaste OAuth 2-toepassingen van uw organisatie met behulp van JWT-flow.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 die PKCE gebruikt, zie Configureer en gebruik de aangepaste OAuth 2-toepassingen van uw organisatie met PKCE-stroom.
OAuth2-processen voor de vergunningenscodesstroom
Autoriseren met een machtigingscode en toegangstoken authorizing-with-an-authorization-code-and-access-token
-
ClientApp heeft informatie nodig van Workfront, zodat het een verzoek aan de Workfront API
/authorizeeindpunt. Het verzoek omvat de response_typecode, die aangeeft dat de aanvraag een machtigingscode moet retourneren. -
Deze triggers Workfront om een verificatieverzoek naar de gebruiker te verzenden. De gebruiker kan zijn geloofsbrieven in de herinnering ingaan, die geeft Workfront toestemming om te communiceren met ClientApp. Als de gebruiker al is aangemeld Workfront, kan deze stap worden overgeslagen.
-
De Workfront API verzendt een machtigingscode naar ClientApp.
-
ClientApp verzendt de volgende informatie in een verzoek naar de Workfront API
/tokeneindpunt:- De machtigingscode die in stap 3 naar ClientApp is verzonden. Dit identificeert het specifieke geval van gebruikerstoestemming.
- Het clientgeheim dat is gegenereerd toen u de ClientApp OAuth2-app instelde in Workfront. Dit maakt Workfront om te weten dat het verzoek van ClientApp komt.
-
Indien de vergunningscode en het cliëntgeheim correct zijn, Workfront verzendt een toegangstoken naar ClientApp. Dit toegangstoken wordt rechtstreeks verzonden van Workfront naar ClientApp en kan niet worden weergegeven, gekopieerd of gebruikt door andere gebruikers- of clienttoepassingen.
-
ClientApp verzendt het toegangstoken naar Workfront samen met het specifieke verzoek om informatie.
-
Omdat het toegangstoken correct is, Workfront verzendt de informatie naar ClientApp.
Toegangstokens vernieuwen
Voor veiligheid, verlopen de toegangstokens na een korte hoeveelheid tijd. Om nieuwe toegangstokens te krijgen zonder het moeten geloofsbrieven telkens ingaan, OAuth2 gebruikt vernieuwt tokens. Vernieuwingstokens worden door de client opgeslagen.
Het proces om een te verwerven vernieuwt teken is het zelfde als de procedure die in de sectie wordt besproken Autoriseren met een machtigingscode en toegangstoken. Het verzoek om de vergunningscode omvat het toepassingsgebied offline_access, die erop wijst dat het verzoek een verzoekteken samen met de vergunningscode zou moeten terugkeren.