Créer et gérer des jetons d'accès HighBond

Créez ou gérez vos jetons d'accès HighBond personnels sur la page Gérer les jetons d'API accessible sur votre page de profil de la Barre de lancement.

Qu'est-ce qu'un jeton d'accès ?

Un jeton d'accès est une chaîne de caractères qui identifie un utilisateur et qui authentifie l'accès aux autres applications.

Les jetons d'accès dont vous avez besoin dépendent de ce que vous voulez faire :

• Importer des données de Diligent One Projets dans Analytics — Jeton Analytics ou jeton d'API HighBond
• Importer des données de Diligent One Résultats dans Analytics — Jeton Analytics ou jeton d'API HighBond
• Exporter des données de Diligent One Résultats à partir d'Analytics — Jeton Analytics ou jeton d'API HighBond
• Bénéficier d'un accès programmatique à Diligent One — Jeton d'API HighBond
• Bénéficier d'un accès programmatique aux journaux d'activité de la barre de lancement — Jeton d'API de journaux d'activité

  Remarque

  L'accès aux journaux d'activité de la Barre de lancement n'est disponible que pour les admins système.

Jeton Analytics

Le jeton Analytics est automatiquement généré à chaque activation d'Analytics et est stocké dans votre registre.

• Si vous utilisez la version 14 d'Analytics ou une version inférieure, et que vous créez manuellement un Jeton d'accès ACLGRC, ce dernier est classé dans la Barre de lancement en tant que jeton de type Analytics.
• Si vous utilisez la version 14.1 d'Analytics, et que vous créez manuellement un Jeton d'accès HighBond, ce dernier est classé dans la Barre de lancement en tant que jeton de type Analytics.

Fonctionnement

Dans la Barre de lancement, la page Gérer des jetons API affiche tous les jetons d'accès que vous avez générés.

Vous pouvez utiliser la page Gérer des jetons d'accès API pour :

• copier vos jetons
• indiquer un libellé permettant de décrire ou d'identifier des jetons d'accès
• verrouiller les jetons d'accès pour empêcher leur modification ou leur suppression
• supprimer des jetons d'accès

Autorisations

Tous les utilisateurs peuvent créer un jeton Analytics. Vous devez être admin système dans au moins une instance Diligent One pour créer un jeton d'API HighBond ou un jeton d'API de journaux d'activité.

Tous les utilisateurs peuvent gérer leurs propres jetons d'accès.

Créer des jetons d'accès

1. Ouvrez la Barre de lancement.

Remarque

Si votre entreprise utilise plus d’une instance dans Diligent One, assurez-vous que la bonne instance est active.

2. Sélectionnez > Profil.
3. À côté de Jetons d'application, cliquez sur Gérer. La page Gérer des jetons API s'affiche.
4. Cliquez sur + Ajouter un jeton et sélectionnez l'option appropriée dans le menu déroulant (par exemple : API HighBond, Analytics ou API des journaux d'activités). Le panneau latéral Nouveau jeton apparaît.
5. Renseignez les champs du panneau latéral pour créer un jeton.

   Remarque

   Tous les champs sont requis pour créer un jeton, y compris le champ Description. La seule exception est si vous choisissez de ne pas inclure d'expiration pour le jeton. Dans ce cas, vous n'avez pas besoin d'indiquer le nombre de jours au bout desquels le jeton doit expirer, car la valeur par défaut est Jamais.

   1. Saisissez une description.

      Astuce

      Dans la description, incluez tous les emplacements où ce jeton sera utilisé et l'objectif. En effet, les jetons devant être remplacés lorsqu'ils expirent, l'ajout d'une description détaillée vous permettra de gagner du temps et de réduire vos efforts lors du remplacement.

   2. Facultatif. Activez ou désactivez l'expiration du jeton.

      Remarque

      L'option permettant de définir l'expiration du jeton doit être activée par défaut. Si cette option est désactivée, le jeton n'expirera jamais.

   3. Saisissez le nombre de jours au bout desquels le jeton doit expirer, dans la limite d'un an (365 jours) à compter de la date de création du jeton.
   4. Saisissez le mot de passe de votre compte Diligent One pour confirmer votre identité.
6. Cliquez sur Générer un jeton. Le panneau latéral est actualisé avec un message confirmant que votre jeton a été généré, et comporte l'ID du jeton, la date d'expiration (date et heure d'expiration du jeton) et la description.
7. Cliquez sur Copier. Le message Copié dans le presse-papiers confirme que le jeton a été copié.

   Attention

   Enregistrez votre jeton avant de fermer ce panneau latéral. Par souci de sécurité, il s'agit de votre unique occasion d'y accéder. Si vous n'enregistrez pas votre jeton et l'oubliez, vous devrez en créer un autre.
8. Cliquez sur Fermer. Le panneau latéral Nouveau jeton se ferme.
9. Collez le jeton dans une application ou un script.

   Remarque

   Traitez le jeton comme un mot de passe et ne le partagez pas avec des tiers.

Gérer des jetons API

Sur la page Gérer les jetons API, vous pouvez afficher la liste des jetons existants, modifier leur description, les verrouiller pour empêcher leur modification et leur suppression, et en supprimer.

1. Ouvrez la Barre de lancement.

Remarque

Si votre entreprise utilise plus d’une instance dans Diligent One, assurez-vous que la bonne instance est active.

2. Sélectionnez > Profil.
3. À côté de Jetons d'application, cliquez sur Gérer. La page Gérer des jetons API s'affiche.
4. Effectuez l'une des actions suivantes.

Examiner les jetons d’accès

Vous pouvez rechercher des jetons, les trier et les filtrer afin de localiser des jetons spécifiques. Effectuez l'une des opérations suivantes :

• Rechercher des jetons : saisissez les premiers caractères du jeton d'accès (jusqu'à sept caractères) dans la barre de recherche. Une liste restreinte de résultats apparaît.
• Trier les jetons : cliquez sur l'un des intitulés de colonne pour trier les jetons en fonction de la colonne choisie selon un ordre croissant ou décroissant.
• Filtrer les jetons : tous les jetons générés sont affichés par défaut. Toutefois, vous pouvez filtrer la liste des jetons sur un sous-ensemble, par exemple sur les jetons verrouillés ou selon le type de jeton : Analytics, Journaux d'activité ou API HighBond. Sélectionnez les filtres souhaités dans les menus déroulants disponibles pour filtrer la liste des jetons. Cliquez sur Effacer pour supprimer tous les filtres.

Modifier la description d'un jeton d'accès

1. Cliquez sur le crayon . Le champ Description peut être modifié de façon incorporée.
2. Apportez des modifications à la description et cliquez sur la coche pour les enregistrer. La description mise à jour apparaît dans la table.

Verrouiller ou déverrouiller des jetons d’accès

Pour empêcher la suppression des jetons et la modification de leur description, vous pouvez les verrouiller. Vous pouvez également déverrouiller les jetons pour modifier leur description et permettre leur suppression.

• Cliquez sur le verrou ouvert à côté de votre jeton pour désactiver les options permettant de le supprimer et de modifier sa description. Le verrou apparaît fermé pour indiquer que le jeton ne peut être modifié ni supprimé. Par ailleurs, le crayon et la corbeille disparaissent.
• Cliquez sur le verrou fermé à côté de votre jeton pour activer les options permettant de le supprimer et de modifier sa description. Le verrou apparaît ouvert pour indiquer que la modification et la suppression sont activées. Par ailleurs, le crayon et la corbeille réapparaissent.

Supprimer des jetons d'accès

Vous pouvez supprimer un seul jeton, plusieurs jetons à la fois ou tous les jetons de la liste. Si vous n'avez pas besoin de conserver les jetons précédents à des fins de référence, vous pouvez les supprimer pour réduire la liste des jetons. Toutefois, toute décision de supprimer des jetons doit être prise avec prudence et uniquement après avoir vérifié qu'il n'est pas utilisé ailleurs, car la suppression est définitive et irréversible.

Supprimer un seul jeton

1. Cliquez sur la corbeille à côté du jeton. La boîte de dialogue Supprimer # jeton ? apparaît pour confirmer la suppression.
2. Cliquez sur Supprimer le jeton. Le jeton est définitivement supprimé et retiré de la liste.

Attention

La suppression d'un jeton est définitive et irréversible. Si un jeton est en cours d'utilisation lorsque vous le supprimez, tout processus qui l'utilise échouera. Si un jeton est supprimé par erreur, vous devrez le recréer et le réinsérer dans l'application ou le script concerné.

Supprimer plusieurs jetons

1. Cliquez sur les cases à cocher correspondant aux jetons à supprimer. Un bouton rouge apparaît au-dessus de la liste des jetons et indique le nombre de jetons à supprimer.
2. Cliquez sur Supprimer # jetons. La boîte de dialogue Supprimer # jeton ? apparaît pour confirmer la suppression.
3. Cliquez sur Supprimer les jetons. Les jetons sont définitivement supprimés et retirés de la liste.

Attention

La suppression d'un jeton est définitive et irréversible. Si un jeton est en cours d'utilisation lorsque vous le supprimez, tout processus qui l'utilise échouera. Si un jeton est supprimé par erreur, vous devrez le recréer et le réinsérer dans l'application ou le script concerné.

Supprimer tous les jetons

1. Sélectionnez la case à cocher à côté de l'icône d'information . Cette opération sélectionne automatiquement tous les jetons de la liste. Un bouton rouge apparaît au-dessus de la liste des jetons et indique le nombre de jetons à supprimer.
2. Cliquez sur Supprimer # jetons. La boîte de dialogue Supprimer # jetons ? apparaît pour confirmer la suppression.
3. Cliquez sur Supprimer # jetons. Les jetons sont définitivement supprimés et retirés de la liste.

Attention

La suppression d'un jeton est définitive et irréversible. Si un jeton est en cours d'utilisation lorsque vous le supprimez, tout processus qui l'utilise échouera. Si un jeton est supprimé par erreur, vous devrez le recréer et le réinsérer dans l'application ou le script concerné.

Gérer les jetons arrivant à expiration

Plusieurs rappels seront envoyés jusqu'à la suppression ou l'expiration du jeton. Les créateurs de jeton recevront des e-mails de notification 30 jours, 5 jours et 1 jour avant la date d'expiration d'un jeton. Une notification sera également envoyée par e-mail à l'expiration du jeton. Lorsqu'un jeton expire, tous les processus qui en dépendent échouent, à moins que vous ne le remplaciez par un nouveau jeton.

Remplacer un jeton arrivant à expiration par un nouveau jeton

Pour éviter l'échec des processus, les jetons arrivant à expiration et expirés doivent être remplacés par de nouveaux jetons. Pour mettre à jour un jeton, vous devez en créer un autre. Consultez la rubrique Créer des jetons d'accès. Une fois que vous avez créé un jeton, localisez toutes les instances utilisées par le jeton arrivant à expiration et remplacez celui-ci par le nouveau jeton.

Supprimer un jeton arrivant à expiration

Supprimez les jetons arrivant à expiration pour arrêter de recevoir les notifications concernant une expiration à venir et pour supprimer tout jeton dont vous n'avez plus besoin à des fins de référence. Consultez la rubrique Supprimer des jetons d'accès.