Créer des applications OAuth2 pour les intégrations Workfront
En tant qu'administrateur 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 peuvent alors autoriser ces autres applications à accéder à leurs données Workfront. Ainsi, vous pouvez intégrer avec les applications de votre choix, y compris vos propres applications internes.
Lorsque vous créez une application OAuth2, vous générez un identifiant client et un secret client. Vos utilisateurs peuvent ensuite utiliser l’ID client dans les appels API pour s’intégrer à l’application que vous avez créée.
- Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 avec les informations d’identification de l’utilisateur (flux de code d’autorisation), voir Configuration et utilisation 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 Configuration et utilisation des applications OAuth 2 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 Configuration et utilisation des applications OAuth 2 personnalisées de votre entreprise à l’aide de PKCE flow.
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 forfait* | N’importe quelle |
| Adobe Workfront licence* |
Nouvelle : Standard Ou Actuel :Plan |
| Configurations des niveau d’accès* | Vous devez être un administrateur ou une administratrice de Workfront. |
*Pour connaître le plan, le type de licence ou l’accès dont vous disposez, contactez votre administrateur ou administratrice Workfront.
Présentation d’OAuth2
Imaginez qu’une application doit 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 accéder aux informations d’un utilisateur particulier et doit donc accéder à Workfront en tant qu’utilisateur. Si votre utilisateur donne à ClientApp son nom d’utilisateur et son mot de passe, il peut accéder à toutes les données auxquelles il 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 seulement si l’utilisateur dont le compte Accès à 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.
Solution recommandée pour les interfaces de ligne de commande, les démons ou les scripts exécutés sur votre serveur
Exemples :
-
Shell
-
Python
Le meilleur pour les applications web mobiles ou mono-page
Exemples :
-
Javascript
-
Angular
-
React
-
Vue
Solution recommandée 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 System, puis sélectionnez OAuth2 Applications.
-
Cliquez sur Créer une intégration d’application.
La zone Nouvelle application OAuth2 s’affiche. -
Dans la zone Nouvelle application OAuth2, sélectionnez Machine to Machine Application.
-
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 Supprimer
-
Cliquez sur Ajouter le secret client 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 Ajouter une clé publique et saisissez la clé publique de l’autre application.
-
Cliquez sur Générer une paire de clés publique/privée, puis partagez la clé publique avec l’autre application.
Name C'est le même nom que celui que vous avez donné à l'application. Ce champ ne peut 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 (flux de code d’autorisation), voir Configuration et utilisation des applications OAuth 2 personnalisées de votre entreprise à l’aide du flux JWT.
Création d’une application OAuth2 à l’aide des informations d’identification de l’utilisateur (flux de code d’autorisation) create-an-oauth2-application-using-user-credentials-authorization-code-flow
-
Cliquez sur l’icône Menu principal
-
Dans le panneau de navigation de gauche, cliquez sur System, puis sélectionnez OAuth2 Applications.
-
Cliquez sur Créer une intégration d’application.
Nouvelle application OAuth2 s’affiche.
-
Dans la zone Nouvelle application OAuth2, sélectionnez Application Web.
-
Saisissez un nom pour la nouvelle application OAuth2, 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 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 Supprimer
-
Cliquez sur Ajouter le secret client pour générer un nouveau secret client.
URL de redirection Les utilisateurs seront redirigés vers ce chemin après s’être authentifiés avec Workfront. Actualiser la rotation du jeton 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. Expiration absolue du jeton d’actualisation Sélectionnez la durée pendant laquelle vous souhaitez qu’un jeton d’actualisation existe avant son expiration. À son expiration, vos utilisateurs 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, si l’utilisateur n’a pas été actif dans votre système, son jeton d’actualisation expire.
Par exemple, si l’expiration du jeton d’actualisation d’inactivité est de 6 mois et que l’utilisateur ne se connecte pas pendant six mois, le jeton d’actualisation expire même si l’expiration du jeton d’actualisation absolu peut être définie pour plus longtemps.
Logo Vous pouvez ajouter un logo pour rendre cette application plus identifiable. Name C'est le même nom que celui que vous avez donné à l'application. Ce champ ne peut pas être vide. Description Saisissez une description pour l’intégration. URL de description de l’application 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 (flux de code d’autorisation), voir Configuration et utilisation des applications OAuth 2 personnalisées de votre entreprise à l’aide du flux de code d’autorisation.
Créer une application web OAuth2 mono-page à 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 System, puis sélectionnez OAuth2 Applications.
-
Cliquez sur Créer une intégration d’application.
La zone Nouvelle application OAuth2 s’affiche.
-
Dans la zone Nouvelle application OAuth2, sélectionnez Application Web Mono-Page.
-
Saisissez un nom pour la nouvelle application OAuth2, 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 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. URL de redirection Les utilisateurs seront redirigés vers ce chemin après s’être authentifiés auprès de Workfront. Rotation du jeton d’actualisation à chaque utilisation 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. Expiration absolue Sélectionnez la durée d’existence d’un jeton d’actualisation avant son expiration. À son expiration, vos utilisateurs doivent à nouveau se connecter à l’intégration. Sélectionnez "No expiration" si vous ne souhaitez pas que le jeton d’actualisation expire. Délai d’expiration de l’inactivité Sélectionnez la durée au bout de laquelle, si l’utilisateur n’a pas été actif dans votre système, son jeton d’actualisation expire.
Par exemple, si l’expiration du jeton d’actualisation d’inactivité est de 6 mois et que l’utilisateur ne se connecte pas pendant six mois, le jeton d’actualisation expire même si l’expiration du jeton d’actualisation absolu peut être définie pour plus longtemps.
Logo Vous pouvez ajouter un logo pour rendre cette application plus identifiable. Name C'est le même nom que celui que vous avez donné à l'application. Ce champ ne peut pas être vide. Description Saisissez une description pour l’intégration. Nom du développeur Il s’agit du nom du développeur qui configure l’application OAuth2. Adresse électronique du développeur Il s’agit de l’adresse électronique du développeur qui configure l’application OAuth2. URL de la politique de confidentialité Il s’agit du lien vers lequel votre entreprise stocke la politique de confidentialité. -
Cliquer sur Enregistrer.
Configuration et utilisation de l’application OAuth2 créée
La configuration et l’utilisation ultérieures de l’application OAuth2 créée nécessitent quelques connaissances techniques, y compris les appels d’API.
- Pour plus d’informations sur la configuration et l’utilisation de l’application OAuth2 avec les informations d’identification de l’utilisateur (flux de code d’autorisation), voir Configuration et utilisation 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 Configuration et utilisation des applications OAuth 2 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 Configuration et utilisation des applications OAuth 2 personnalisées de votre entreprise à l’aide de PKCE flow.
Processus OAuth2 pour le flux de code d’autorisation
Autorisation 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, de sorte qu’il envoie une requête au point de terminaison Workfront de l’API
/authorize. La requête inclut le response_typecode, ce qui indique que la requête doit renvoyer un code d’autorisation. -
Cela déclenche Workfront pour envoyer une invite d’authentification à l’utilisateur. L’utilisateur peut saisir ses informations d’identification dans l’invite, qui autorise Workfront à communiquer avec ClientApp. Si l’utilisateur est déjà connecté à 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 à l’ Workfront API
/tokenendpoint :- Code d’autorisation envoyé à ClientApp à l’étape 3. Cela identifie l’instance spécifique de l’autorisation utilisateur.
- Secret client généré lors de la configuration de l’application OAuth2 ClientApp 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 à ClientApp et ne peut pas être affiché, copié ou utilisé par un autre utilisateur ou une autre application cliente.
-
ClientApp envoie le jeton d'accès à Workfront avec la demande d'informations spécifique.
-
Comme le jeton d’accès est correct, Workfront envoie les informations à ClientApp.
Actualisation des jetons d’accès
Pour la 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 d’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 pour le 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.