OAuth2-toepassingen maken voor Workfront -integratie
Als Adobe Workfront beheerder kunt u OAuth2-toepassingen maken voor uw instantie van Workfront , waarmee andere toepassingen toegang hebben tot Workfront . Uw gebruikers kunnen deze andere toepassingen vervolgens toestemming geven om toegang te krijgen tot hun Workfront -gegevens. Op deze manier kunt u met toepassingen van uw keuze, inclusief uw eigen interne toepassingen.
Wanneer u een OAuth2 -toepassing maakt, genereert u een client-id en een clientgeheim. 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 vormen en gebruiken de douane OAuth 2 van uw organisatie toepassingen gebruikend de stroom van de vergunningscode.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 die serverauthentificatie (stroom JWT) gebruiken, zie vormen en gebruiken de douane OAuth 2 van uw organisatie toepassingen gebruikend stroom JWT.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 die PKCE gebruiken, zie vorm en gebruik de douane OAuth 2 van uw organisatie toepassingen gebruikend de stroom van PKCE.
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 zijn. |
Voor meer detail over de informatie in deze lijst, zie vereisten van de Toegang in de documentatie van Workfront.
OAuth2-overzicht
Stel dat een toepassing bepaalde specifieke informatie van Workfront moet ophalen. Een toepassing die om informatie verzoekt wordt genoemd een cliënt. In dit voorbeeld is de naam van de client ClientApp. ClientApp heeft toegang nodig tot de informatie van een bepaalde gebruiker en moet daarom Workfront als die gebruiker benaderen. 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 in feite Workfront dat ClientApp toegang heeft tot Workfront , maar alleen als de gebruiker wiens account ClientApp toegang heeft, 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 het Main Menu pictogram
-
Klik in het navigatievenster aan de linkerkant op System en selecteer vervolgens OAuth2 Applications .
-
Klik op Create app integration .
De Nieuwe OAuth2 toepassings vakvertoningen. -
In het Nieuwe OAuth2 toepassings vakje, uitgezochte Machine to Machine Application.
-
Ga een naam voor de nieuwe toepassing, zoals "Workfront voor ClientApp in."
-
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 het pictogram Delete
-
Klik op Add client secret om een nieuw clientgeheim te genereren.
Public Keys Server-naar-server-apps gebruiken openbare en persoonlijke sleutels voor verificatie. Voer een van de volgende handelingen uit:
-
Klik op Add a public key en voer de openbare sleutel in vanuit de andere toepassing.
-
Klik op Generate a public/private keypair en deel 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 vormen en gebruiken de douane OAuth 2 van uw organisatie toepassingen gebruikend stroom JWT.
Een OAuth2-toepassing maken met gebruikersgegevens (doorloop machtigingscode) create-an-oauth2-application-using-user-credentials-authorization-code-flow
https://app.workfrontfusion.com/oauth/cb/workfront-workfronthttps://app-eu.workfrontfusion.com/oauth/cb/workfront-workfront(EU-datacenter)https://app-az.workfrontfusion.com/oauth/cb/workfront-workfront(Azure Data Center)
-
Klik het Main Menu pictogram
-
Klik in het navigatievenster aan de linkerkant op System en selecteer vervolgens OAuth2 Applications .
-
Klik op Create app integration.
De Nieuwe OAuth2 toepassings vertoningen.
-
In het Nieuwe OAuth2 toepassings vakje, uitgezochte Web Application.
-
Ga een naam voor de nieuwe toepassing OAuth2, zoals "Workfront voor ClientApp in."
-
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 het pictogram Delete
-
Klik op Add client secret om een nieuw clientgeheim te genereren.
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. Selecteer "No expiration"als u niet wilt verfrissen teken verlopen. 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 vormen en gebruiken 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 het Main Menu pictogram
-
Klik in het navigatievenster aan de linkerkant op System en selecteer vervolgens OAuth2 Applications .
-
Klik op Create app integration.
De Nieuwe OAuth2 toepassings vakvertoningen.
-
In het Nieuwe OAuth2 toepassings vakje, uitgezochte Single Page Web Application.
-
Voer een naam in voor de nieuwe OAuth2 -toepassing, bijvoorbeeld "Workfront for 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. Selecteer "No expiration"als u niet wilt verfrissen teken verlopen. 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 vormen en gebruiken de douane OAuth 2 van uw organisatie toepassingen gebruikend de stroom van de vergunningscode.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 die serverauthentificatie (stroom JWT) gebruiken, zie vormen en gebruiken de douane OAuth 2 van uw organisatie toepassingen gebruikend stroom JWT.
- Voor instructies bij het vormen van en het gebruiken van de toepassing OAuth2 die PKCE gebruiken, zie vorm en gebruik de douane OAuth 2 van uw organisatie toepassingen gebruikend de stroom van PKCE.
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 en verzendt dus een aanvraag naar het eindpunt van de Workfront API
/authorize. De aanvraag bevat de instructie response_typecode, die aangeeft dat de aanvraag een machtigingscode moet retourneren. -
Dit activeert Workfront om een verificatieverzoek naar de gebruiker te verzenden. De gebruiker kan zijn of haar referenties invoeren bij de vraag, die Workfront toestemming geeft om te communiceren met ClientApp. Als de gebruiker zich al bij Workfront heeft aangemeld, kan deze stap worden overgeslagen.
-
De Workfront API verzendt een vergunningscode naar ClientApp.
-
ClientApp verzendt de volgende informatie in een aanvraag 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 . Hierdoor kan Workfront weten dat de aanvraag afkomstig is van ClientApp.
-
Als de machtigingscode en het clientgeheim correct zijn, verzendt Workfront een toegangstoken naar ClientApp. Deze toegangstoken wordt rechtstreeks vanuit Workfront naar ClientApp verzonden en kan niet worden weergegeven, gekopieerd of gebruikt door een andere gebruiker of clienttoepassing.
-
ClientApp verzendt het toegangstoken naar Workfront samen met het specifieke verzoek om informatie.
-
Omdat het toegangstoken correct is, verzendt Workfront 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 verfrist tokens. Vernieuwingstokens worden door de client opgeslagen.
Het proces om een te verwerven verfrist teken is het zelfde als de procedure die in de sectie wordt besproken die met een vergunningscode en toegangstokengoedkeurt. Het verzoek om de vergunningscode omvat het werkingsgebied offline_access, dat erop wijst dat het verzoek een verzoekteken samen met de vergunningscode zou moeten terugkeren.