Accueil de Canva
Aide

Configurer et utiliser l’API Canva Admin


Cet article a été traduit automatiquement. Si vous repérez des erreurs, merci de nous les signaler.

Remarque : vous devez indiquer une organisation sur Canva pour utiliser l’API Admin. L’API Admin fonctionne au niveau de l’organisation.

Vous pouvez utiliser l’API Admin de Canva pour automatiser la gestion de votre organisation à partir de vos propres systèmes. Gérez les membres, les équipes, les groupes et les adhésions, et récupérez les événements des journaux d’audit sans devoir effectuer ces tâches manuellement dans Canva.

Vérifier la disponibilité

  • Disponible avec Canva Enterprise, Canva Districts et Canva Campus.
  • Accessible aux administrateurs de l’organisation.
  • Disponible pour les organisations avec une ou plusieurs équipes.

Vérifier les conditions requises

Avant de configurer l’API Admin, vérifiez que votre organisation répond aux conditions suivantes :

  • Niveau de l’organisation : l’API Admin s’applique à l’organisation. Elle est disponible pour les organisations avec une ou plusieurs équipes disposant d’un abonnement Canva Enterprise, Canva Districts ou Canva Campus.
  • Compte d’administrateur de l’organisation : seuls les administrateurs de l’organisation peuvent créer et gérer des clients de l’API Admin dans les paramètres Canva.
  • Équipe technique interne ou externe : votre organisation doit disposer de ressources techniques pour créer et maintenir l’intégration. Canva ne fournit pas d’assistance à la mise en œuvre.
    • Si votre équipe n’est pas en mesure de développer une intégration avec une API, le provisionnement SCIM est une meilleure solution pour automatiser la gestion des utilisateurs de votre organisation.
  • Connaissance de votre structure Canva : avant de créer votre intégration, assurez-vous de bien comprendre la configuration de votre organisation, de vos équipes et de vos groupes dans Canva.
  • Authentification multifacteur (MFA) ou compte géré par l’authentification unique (SSO) : l’administrateur de l’organisation qui configure l’API Admin doit avoir activé la MFA ou disposer d’un compte géré par l’authentification unique. Le compte doit être géré ou détenu par l’organisation qu’il représente.

Comprendre ce que vous pouvez gérer

L’API Admin propose des points de terminaison pour :

  • Les membres, les équipes et les groupes : les créer, les consulter, les modifier et les supprimer.
  • Les adhésions : ajouter ou retirer des personnes des équipes et des groupes, et leur attribuer des rôles.
  • Les journaux d’audit : récupérer les événements des journaux d’audit selon une fréquence définie.
  • Les invitations à rejoindre une équipe : inviter des personnes dans une équipe (y compris des personnes externes à votre organisation), consulter les invitations en attente, récupérer un lien d’invitation existant à partir de l’adresse e-mail exacte et annuler des invitations.

Configurer l’API Admin

Un administrateur de l’organisation crée un client de l’API Admin et l’utilise pour appeler l’API.

Configurer l’API Admin

  1. Accédez à
    paramètres.
  2. Sélectionnez API d'administration, puis sélectionnez Créer un client API.
  3. Nommez le client et sélectionnez les étendues qui définissent ce à quoi le client peut accéder.
  4. Sélectionnez Continuer.
  5. Copiez l'ID client et la clé secrète du client, puis sélectionnez Terminé.
  6. Échangez les identifiants contre un jeton d'accès, qui est valide pendant quatre heures.
  7. Utilisez le jeton d'accès pour appeler l'API d'administration.

Suivez la documentation de l’API Admin de Canva pour échanger vos identifiants client contre un jeton d’accès et commencer à envoyer des requêtes à l’API.

Pour obtenir des informations techniques sur l’authentification des requêtes API et l’utilisation des jetons porteurs OAuth 2.0, partagez la documentation sur l’authentification de l’API Admin de Canva avec votre équipe technique.

Comprendre les journaux d’audit de l’API Admin

Les actions effectuées via l’API Admin sont attribuées au client de l’API Admin, et non à l’administrateur qui l’a utilisé.

Dans les journaux d’audit, le champ « Acteur » affiche le nom et l’identifiant du client de l’API Admin. Cela vous aide à identifier l’intégration à l’origine d’une action.

Vous pouvez également identifier l’administrateur de l’organisation qui a créé, modifié ou supprimé un client API spécifique.

Pour en savoir plus, consultez À propos des journaux d’audit Canva.

Inviter des personnes dans des équipes

Les administrateurs de l’organisation peuvent utiliser l’API Admin pour inviter des personnes dans une équipe, y compris des collaborateur·rices externes à leur organisation.

À savoir

  • Chaque invitation créée concerne une équipe et une adresse e-mail.
  • Chaque invitation ne peut être utilisée qu’une seule fois et expire après 30 jours.
  • Selon votre configuration, Canva n’enverra peut-être pas automatiquement d’e-mail à la personne invitée. Si nécessaire, partagez directement le lien d’invitation avec cette personne.
  • Gardez les liens d’invitation privés. Un lien d’invitation ne fonctionne que pour l’adresse e-mail à laquelle il a été créé.
  • Les paramètres d’invitation et de domaine déjà définis pour votre équipe s’appliquent également aux personnes que vous invitez.
  • Si une invitation en attente existe déjà pour la personne concernée, la création d’une nouvelle invitation renvoie le même enregistrement d’invitation. La date d’expiration est alors repoussée de 30 jours à compter de la demande et le rôle de la personne invitée est mis à jour selon le rôle demandé.

Pour en savoir plus sur les points de terminaison, consultez la documentation de l’API Admin de Canva.

Choisir entre l’API Admin et SCIM

L’API Admin et SCIM permettent tous deux de gérer le provisionnement des utilisateurs.

L’API Admin permet de gérer d’autres aspects de l’organisation Canva que le provisionnement des utilisateurs, notamment les équipes, les groupes, les adhésions et les journaux d’audit.

SCIM prend en charge le provisionnement et le déprovisionnement standard. Si vous avez uniquement besoin du provisionnement standard des utilisateurs ou si votre équipe n’est pas en mesure de créer une intégration API personnalisée, SCIM répondra mieux à vos besoins.

FAQ

Mon organisation a-t-elle besoin d’une personne développeuse pour utiliser l’API Admin ?

Oui. Pour utiliser l’API Admin, votre organisation doit disposer de ressources techniques internes ou externes pour créer et maintenir l’intégration. Canva ne fournit pas d’assistance à la mise en œuvre. Si votre équipe n’est pas en mesure de développer une intégration avec une API, le provisionnement SCIM est une meilleure solution pour automatiser la gestion des utilisateurs de votre organisation.

Tout le monde dans mon organisation doit-il utiliser la MFA ou l’authentification unique pour se servir de l’API Admin ?

Non. Seul l’administrateur de l’organisation qui configure l’API Admin doit avoir activé la MFA ou disposer d’un compte géré par l’authentification unique. Le compte doit être géré ou détenu par l’organisation qu’il représente. Les autres membres de l’organisation n’ont pas besoin d’utiliser la MFA ou l’authentification unique pour que l’API Admin fonctionne.

Mon organisation peut-elle inviter des collaborateur·rices externes à l’aide de l’API Admin ?

Oui. Les administrateurs de l’organisation peuvent utiliser l’API Admin pour inviter des personnes dans des équipes, y compris des collaborateur·rices externes. Les paramètres d’invitation et de domaine déjà définis pour votre équipe s’appliquent également aux personnes que vous invitez.

Pouvons-nous récupérer un lien d’invitation existant sans créer une nouvelle invitation ?

Oui. Vous pouvez récupérer un lien d’invitation existant à l’aide de l’adresse e-mail exacte de la personne invitée, sans créer de nouvelle invitation.

Ces informations ont-elles été utiles ?

Utile

Inutiles

Articles similaires