DocumentatieWorkfrontHandleiding voor Workfront

Configureer en gebruik de aangepaste OAuth 2-toepassingen van uw organisatie met behulp van JWT-flow

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

Gemaakt voor:

  • Ontwikkelaar

Als u wilt integreren met Workfront en uw clienttoepassing in staat wilt stellen namens de gebruiker te communiceren met Workfront, moet u:

  • Een OAuth2-toepassing maken
  • Een certificaat met openbare sleutel maken
  • Een JSON-webtoken (JWT) maken

Een OAuth2-toepassing maken

Voor instructies bij het creëren van de toepassing OAuth2, zie een toepassing OAuth2 creëren gebruikend serverauthentificatie (stroom JWT)in creeer toepassingen OAuth2 voor de integratie van Workfront

NOTE
U kunt tot een totaal van tien Toepassingen OAuth2 in één keer hebben.

Een certificaat met openbare sleutel maken

JWT moet worden ondertekend en basis-64 worden gecodeerd voor opneming in het toegangsverzoek. De JWT-bibliotheken bieden functies om deze taken uit te voeren.

Het token moet worden ondertekend met de persoonlijke sleutel voor een digitaal ondertekeningscertificaat. Als u dat doet, kunt u de persoonlijke sleutel van elk gekoppeld certificaat gebruiken om uw JWT te ondertekenen.

Het gebruikte algoritme is RS256 (RSA-handtekening met SHA-256). Dit is een asymmetrisch algoritme, en het gebruikt een openbare/privé zeer belangrijke paar. De identiteitsprovider heeft een persoonlijke (geheime) sleutel die wordt gebruikt om de handtekening te genereren en de consument van de JWT krijgt een openbare sleutel om de handtekening te valideren.

Om de openbare sleutel te produceren, doe één van het volgende.

  • Open uw terminal van MacOS/Linux en voer het volgende bevel uit, dan upload certificate_pub.crt gebruikend openbare sleutel knoop in de OAuth2 toepassingsopstelling in Workfront.

    code language-none 
    openssl req -x509 -sha256 -nodes -newkey rsa:2048 -keyout private.key -out certificate_pub.crt

  • Gebruik produceert een openbaar/privé sleutelpaar knoop in de OAuth2 toepassingsopstelling in Workfront om RSA te produceren.

Een JSON-webtoken maken

Een JSON-webtoken voor verificatie van serviceaccount vereist een bepaalde set claims en moet worden ondertekend met een geldig digitaal ondertekeningscertificaat. Wij adviseren dat u één van de openbaar beschikbare bibliotheken of hulpmiddelen gebruikt om uw JWT te bouwen.

De volgende lijst bevat informatie over gebieden die kunnen worden vereist wanneer u het teken JWT vormt.

exp

Vereist. De vervalparameter is een vereiste parameter die de absolute tijd vanaf 01/01/1970 GMT meet. U moet ervoor zorgen dat de vervaltijd later is dan het tijdstip van uitgifte. Na deze tijd is de JWT niet meer geldig.

Opmerking: we raden u aan een token met een korte levensduur (enkele minuten) te gebruiken, zodat het kort na de ruil verloopt voor een toegangstoken. Telkens wanneer een nieuw toegangstoken wordt vereist, wordt één JWT ondertekend en geruild. Dit is een veiligere aanpak. We raden niet langer gebruikte tokens aan die opnieuw worden gebruikt om zo nodig toegangstokens te verkrijgen.

is
Vereist. De uitgever is uw klant-id uit de OAuth2-toepassingsgegevens.
sub
Vereist. Het onderwerp is uw Gebruiker - identiteitskaart die de openbare sleutel in opstelling creeerde.

Uitwisseling JWT om een toegangstoken terug te winnen

  1. Verzend een verzoek van de POST naar:

    code language-none 
    https://yourdomain.my.workfront.com/integrations/oauth2/api/v1/jwt/exchange

  2. De hoofdtekst van de aanvraag moet URL-gecodeerde parameters bevatten met uw client-id, clientgeheim en JWT:

    code language-none 
    client_id={client_id_value}&client_secret={client_secret_value}&jwt_token={base64_encoded_JWT}
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43