Comment gérer les jetons d'accès d'API en tant qu'administrateur?

Vous pouvez gérer les jetons d'accès d'API à partir de vos paramètres utilisateur. Les jetons d'accès permettent d'accéder aux ressources de Canvas via l'API Canvas. Les jetons d'accès peuvent être générés automatiquement pour des applications tierces ou créés manuellement.

L'utilisation de l'API Canvas permet au détenteur du jeton d'accès d'accéder aux mêmes ressources Canvas auxquelles vous pouvez accéder. Par exemple, les applications tierces, y compris les périphériques que vous avez utilisés pour ouvrir les applis mobiles de Canvas, sont autorisées à accéder à Canvas en votre nom. Les appels d'API nécessitent une autorisation et sont effectués au nom d'un utilisateur autorisé.  Pour plus d'informations sur l'utilisation de l'API Canvas, consultez la documentation de l'API Canvas.

Une fois que vous disposez d'une connexion Canvas, vous pouvez créer l'un de ces jetons d'accès à utiliser pour tester vos projets de développement. Ce jeton doit être inclus en tant que paramètre de requête d'URL dans tous les appels d'API effectués vers Canvas.

Les jetons de Canvas s'alignent sur les autorisations de Canvas. Si votre compte Canvas est supprimé, vos jetons seront révoqués. Si vous n'avez plus de rôle administratif dans Canvas, vos jetons générés précédemment s'adapteront à vos nouvelles autorisations.

Remarque :

  • Les utilisateurs disposant de privilèges de fausse identité ne peuvent pas supprimer le jeton au nom d'autres utilisateurs.
  • Les administrateurs de Canvas ne peuvent pas supprimer en masse les jetons d'accès d'API pour les utilisateurs de leur institution.

Ouvrir Paramètres utilisateur

Ouvrir Paramètres utilisateur

Dans Navigation globale, cliquez sur le lien Compte (Account) [1], puis cliquez sur le lien Paramètres (Settings) [2].

Afficher les jetons d'accès

Les applications tierces avec des jetons d'accès et des jetons d'accès générés par l'utilisateur sont énumérés dans la section Intégrations approuvées (Approved Integrations) [1].

Pour chaque jeton d'accès, vous pouvez voir le nom [2], le but [3], la date d'expiration [4] et la date de la dernière utilisation [5].

Ajouter un jeton d'accès

Ajouter un jeton d'accès

Pour ajouter un jeton d'accès, cliquez sur le bouton Ajouter un nouveau jeton d'accès (Add New Access Token).

Ajouter les informations sur les jetons

Ajouter les informations sur les jetons

Saisissez une description pour votre jeton d'accès dans le champ Objet (Purpose) [1]. Vous pouvez également sélectionner une date d'expiration en cliquant sur l'icône Calendrier [2]. Pour générer un jeton sans expiration, laissez le champ Expire vide.

Pour générer un nouveau jeton d'accès, cliquez sur le bouton Générer un jeton (Generate Token) [3].

Afficher le jeton d'accès

Afficher le jeton d'accès

Afficher la description du jeton [1]. Pour afficher les informations du jeton, cliquez sur le lien Informations (Details) [2].

Afficher les informations du jeton

Afficher les informations du jeton

Les informations du jeton d'accès comprennent un jeton qui peut être utilisé pour passer des appels API en votre nom [1].

Pour régénérer un jeton d'accès, cliquez sur le bouton Régénérer le jeton (Regenerate Token) [2].

Supprimer le jeton d'accès

Supprimer le jeton d'accès

Pour supprimer un jeton d'accès, cliquez sur l'icône Supprimer (Delete) [6].

Confirmer la suppression

Confirmer la suppression

Pour confirmer la suppression, cliquez sur le bouton OK.