Créer des applications OAuth2 pour les intégrations Workfront
En tant qu’administrateur ou administratrice Adobe Workfront, vous pouvez créer des applications OAuth2 pour votre instance de Workfront, qui permettent à d’autres applications d’accéder à Workfront. Vos utilisateurs et utilisatrices peuvent alors autoriser ces autres applications à accéder à leurs données Workfront. Vous pouvez ainsi intégrer les applications de votre choix, y compris vos propres applications internes.
Lorsque vous créez une application OAuth2, vous générez un ID et un secret client. Vos utilisateurs et utilisatrices peuvent ensuite utiliser l’ID client dans les appels API pour une intégration à l’application que vous avez créée.
- Pour obtenir des instructions sur la configuration et l’utilisation de l’application OAuth2 avec les informations d’identification de l’utilisateur ou utilisatrice (flux de code d’autorisation), voir Configurer et utiliser des applications OAuth 2 personnalisées de votre entreprise à l’aide du flux de code d’autorisation.
- Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 à l’aide de l’authentification du serveur (flux JWT), voir Configurer et utiliser les applications OAuth2 personnalisées de votre entreprise à l’aide du flux JWT.
- Pour obtenir des instructions sur la configuration et l’utilisation de l’application OAuth2 à l’aide de PKCE, voir Configurer et utiliser des applications OAuth 2 personnalisées de votre entreprise à l’aide du flux PKCE.
Conditions d’accès
Vous devez disposer des accès suivants pour effectuer les étapes de cet article :
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront plan | Tous |
| Adobe Workfront licence |
Nouvelle : Standard Ou Actuelle : Plan |
| Configurations des niveaux d’accès | Vous devez être administrateur ou administratrice Workfront. |
Pour plus de détails sur les informations contenues dans ce tableau, consultez Conditions d’accès préalables dans la documentation Workfront.
Vue d’ensemble d’OAuth2
Imaginez qu’une application puisse extraire certaines informations spécifiques de Workfront. Une application qui demande des informations est appelée client. Dans cet exemple, le nom du client est ClientApp. ClientApp doit avoir accès aux informations d’un utilisateur ou d’une utilisatrice spécifique et doit donc accéder à Workfront en tant qu’utilisateur. Si votre utilisateur ou utilisatrice donne à ClientApp son nom d’utilisateur ou d’utilisatrice et son mot de passe, il peut accéder à toutes les données auxquelles l’utilisateur ou l’utilisatrice peut accéder. Il s’agit d’un risque de sécurité, car ClientApp n’a besoin que d’un petit ensemble d’informations spécifiques.
Lorsque vous créez une application OAuth2 pour ClientApp, vous indiquez essentiellement à Workfront que ClientApp est autorisé à accéder à Workfront, mais uniquement si la personne dont le compte auquel accède ClientApp donne l’autorisation d’accès.
Créer une application OAuth2
Lors de la création d’une application OAuth2, choisissez le type d’application qui répond le mieux aux besoins de votre intégration.
Idéale pour les interfaces de ligne de commande, les démons ou les scripts exécutés sur votre serveur
Exemples :
-
Shell
-
Python
Idéale pour les applications web mobiles ou monopages
Exemples :
-
Javascript
-
Angular
-
React
-
Vue
Idéale pour les applications côté serveur qui gèrent les informations d’identification et les jetons sur le serveur.
Exemples :
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
Créer une application OAuth2 à l’aide de l’authentification du serveur (flux JWT) create-an-oauth2-application-using-server-authentication-jwt-flow
-
Cliquez sur l’icône Menu principal
-
Dans le panneau de navigation de gauche, cliquez sur Système, puis sélectionnez Applications OAuth2.
-
Cliquez sur Créer l’intégration d’application.
La zone Nouvelle application OAuth2 s’affiche. -
Dans la zone Nouvelle application OAuth2, sélectionnez Application machine à machine.
-
Saisissez un nom pour la nouvelle application, par exemple « Workfront pour ClientApp ».
-
Cliquez sur Créer.
-
Renseignez les champs de la nouvelle application.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header Client ID Ce champ est généré automatiquement. Client secret Ce champ est généré automatiquement.
IMPORTANT :
copiez le contenu de ce champ dans un autre fichier sécurisé avant de fermer cette page. Vous ne pourrez plus voir cette clé secrète.
Si vous perdez cette clé, supprimez-la et créez un secret client.
-
Cliquez sur l’icône Delete
-
Cliquez sur Add client secret pour générer un nouveau secret client.
Public Keys Les applications serveur à serveur utilisent des clés publiques et privées pour l’authentification. Utilisez l’une des méthodes suivantes :
-
Cliquez sur Add a public key et saisissez la clé publique de l’autre application.
-
Cliquez sur Generate a public/private keypair, puis partagez la clé publique avec l’autre application.
Name Il s’agit du nom que vous avez donné à l’application. Ce champ ne doit pas être vide. Description Saisissez une description pour l’intégration. -
-
Cliquer sur Enregistrer.
Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 avec les informations d’identification de l’utilisateur ou de l’utilisatrice (flux de code d’autorisation), voir la section Configurer et utiliser les applications OAuth 2 personnalisées de votre organisation à l’aide du flux JWT.
Créer une application OAuth2 à l’aide d’informations d’identification d’utilisateur ou d’utilisatrice (flux de code d’autorisation) 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(centre de données de l’UE)https://app-az.workfrontfusion.com/oauth/cb/workfront-workfront(Azure Data Center)
-
Cliquez sur l’icône Menu principal
-
Dans le panneau de navigation de gauche, cliquez sur Système, puis sélectionnez Applications OAuth2.
-
Cliquez sur Créer l’intégration de l’application.
La Nouvelle application OAuth2 s’affiche.
-
Dans la zone Nouvelle application OAuth2, sélectionnez Application web.
-
Saisissez un nom pour la nouvelle application OAuth2, tel que « Workfront pour ClientApp ».
-
Cliquez sur Créer.
-
Renseignez les champs de la nouvelle application.
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 Ce champ est généré automatiquement. Client secret Ce champ est généré automatiquement.
IMPORTANT :
copiez le contenu de ce champ dans un autre fichier sécurisé avant de fermer cette page. Vous ne pourrez plus voir cette clé secrète.
Si vous perdez cette clé, supprimez-la et créez un secret client.
-
Cliquez sur l’icône Delete
-
Cliquez sur Add client secret pour générer un nouveau secret client.
Redirect URLs Les utilisateurs et utilisatrices seront redirigés vers ce chemin après s’être authentifiés auprès de Workfront. Refresh token rotation Activez cette option pour émettre un nouveau jeton d’actualisation lorsque le jeton d’actualisation est utilisé. Votre application doit stocker le nouveau jeton après chaque actualisation. Absolute refresh token expiration Sélectionnez la durée d’existence d’un jeton d’actualisation avant son expiration. À son expiration, vos utilisateurs et utilisatrices doivent à nouveau se connecter à l’intégration. Sélectionnez « No expiration » si vous ne souhaitez pas que le jeton d’actualisation expire. Expiration du jeton d’actualisation d’inactivité Sélectionnez la durée au bout de laquelle le jeton d’actualisation d’un utilisateur ou d’une utilisatrice en inactivité expire.
Par exemple, si l’expiration du jeton d’actualisation pour inactivité est de 6 mois et que l’utilisateur ou utilisatrice ne se connecte pas pendant six mois, le jeton d’actualisation expire même si l’expiration du jeton d’actualisation absolu est définie pour une plus longue durée.
Logo Vous pouvez ajouter un logo pour rendre cette application plus reconnaissable. Name Il s’agit du nom que vous avez donné à l’application. Ce champ ne doit pas être vide. Description Saisissez une description pour l’intégration. App Description URL Il peut s’agir d’un lien vers une page « À propos de nous » ou d’une page contenant plus d’informations sur l’intégration. -
-
Cliquer sur Enregistrer.
Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 avec les informations d’identification de l’utilisateur ou utilisatrice (flux de code d’autorisation), voir Configurer et utiliser les applications OAuth 2 personnalisées de votre entreprise à l’aide du flux de code d’autorisation.
Créer une application web OAuth2 monopage à l’aide de PKCE create-an-oauth2-single-page-web-application-using-pkce
-
Cliquez sur l’icône Menu principal
-
Dans le panneau de navigation de gauche, cliquez sur Système, puis sélectionnez Applications OAuth2.
-
Cliquez sur Créer l’intégration d’application.
La boîte de dialogue Nouvelle application OAuth2 s’affiche.
-
Dans la boîte de dialogue Nouvelle application OAuth2, sélectionnez Application web monopage.
-
Saisissez un nom pour la nouvelle application OAuth2, tel que « Workfront pour ClientApp ».
-
Cliquez sur Créer.
-
Renseignez les champs de la nouvelle application.
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 Ce champ est généré automatiquement. Redirect URLs Les utilisateurs et utilisatrices seront redirigés vers ce chemin après s’être authentifiés auprès de Workfront. Rotate refresh token every time it is used Activez cette option pour émettre un nouveau jeton d’actualisation lorsque le jeton d’actualisation est utilisé. Votre application doit stocker le nouveau jeton après chaque actualisation. Absolute expiration Sélectionnez la durée d’existence d’un jeton d’actualisation avant son expiration. À son expiration, vos utilisateurs et utilisatrices doivent à nouveau se connecter à l’intégration. Sélectionnez « No expiration » si vous ne souhaitez pas que le jeton d’actualisation expire. Inactivity expiration Sélectionnez la durée au bout de laquelle le jeton d’actualisation d’un utilisateur ou d’une utilisatrice en inactivité expire.
Par exemple, si l’expiration du jeton d’actualisation pour inactivité est de 6 mois et que l’utilisateur ou utilisatrice ne se connecte pas pendant six mois, le jeton d’actualisation expire même si l’expiration du jeton d’actualisation absolu est définie pour une plus longue durée.
Logo Vous pouvez ajouter un logo pour rendre cette application plus reconnaissable. Name Il s’agit du nom que vous avez donné à l’application. Ce champ ne doit pas être vide. Description Saisissez une description pour l’intégration. Developer name Il s’agit du nom du développeur ou de la développeuse qui configure l’application OAuth2. Developer email address Il s’agit de l’adresse électronique du développeur ou de la développeuse qui configure l’application OAuth2. Privacy policy URL Il s’agit du lien vers l’emplacement où votre entreprise stocke sa politique de confidentialité. -
Cliquer sur Enregistrer.
Configurer et utiliser l’application OAuth2 créée
La configuration et l’utilisation avancées de l’application OAuth2 créée nécessitent des connaissances techniques, qui incluent les appels API.
- Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 avec les informations d’identification de l’utilisateur ou de l’utilisatrice (flux de code d’autorisation), voir Configurer et utiliser les applications OAuth2 personnalisées de votre entreprise à l’aide du flux de code d’autorisation.
- Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 à l’aide de l’authentification du serveur (flux JWT), voir Configurer et utiliser les applications OAuth2 personnalisées de votre entreprise à l’aide du flux JWT.
- Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 à l’aide de PKCE, voir Configurer et utiliser les applications OAuth2 personnalisées de votre entreprise à l’aide du flux PKCE.
Processus OAuth2 pour le flux de code d’autorisation
Autoriser avec un code d’autorisation et un jeton d’accès authorizing-with-an-authorization-code-and-access-token
-
ClientApp a besoin de certaines informations de Workfront, elle envoie donc une requête au point d’entrée de l’API Workfront
/authorize. La requête inclut l’instruction response_typecode, qui indique que la requête doit renvoyer un code d’autorisation. -
Cela déclenche dans Workfront l’envoi d’une invite d’authentification à l’utilisateur ou à l’utilisatrice. L’utilisateur ou l’utilisatrice peut saisir ses informations d’identification dans l’invite, ce qui accorde à Workfront l’autorisation de communiquer avec ClientApp. Si la personne est déjà connectée à Workfront, cette étape peut être ignorée.
-
L’API Workfront envoie un code d’autorisation à ClientApp.
-
ClientApp envoie les informations suivantes dans une requête au point d’entrée de l’API Workfront
/token:- Le code d’autorisation envoyé à ClientApp à l’étape 3. Cela identifie l’instance spécifique d’autorisation de l’utilisateur ou de l’utilisatrice.
- Le secret client généré lors de la configuration de l’application ClientApp OAuth2 dans Workfront. Cela permet à Workfront de savoir que la demande provient de ClientApp.
-
Si le code d’autorisation et le secret client sont corrects, Workfront envoie un jeton d’accès à ClientApp. Ce jeton d’accès est envoyé directement de Workfront à l’application cliente et ne peut pas être visualisé, copié ou utilisé par un autre utilisateur, une autre utilisatrice ou une autre application cliente.
-
ClientApp envoie le jeton d’accès à Workfront ainsi que la demande d’informations spécifique.
-
Étant donné que le jeton d’accès est correct, Workfront envoie les informations à ClientApp.
Actualiser les jetons d’accès
Pour des raisons de sécurité, les jetons d’accès expirent après un court laps de temps. Pour obtenir de nouveaux jetons d’accès sans avoir à saisir des informations d’identification à chaque fois, OAuth2 utilise des jetons d’actualisation. Les jetons d’actualisation sont stockés par le client.
Le processus d’acquisition d’un jeton d’actualisation est identique à celui décrit dans la section Autorisation avec un code d’autorisation et un jeton d’accès. La requête de code d’autorisation inclut la portée offline_access, qui indique que la requête doit renvoyer un jeton de requête avec le code d’autorisation.