Configurer et utiliser l’API Canva Admin

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

• Disponible avec Canva Entreprise, Canva Districts et Canva Campus.
• Accessible aux admins d’organisation.
• Disponible pour les organisations composées d’une seule équipe ou de plusieurs équipes.

Avant de configurer l’API Admin, vérifiez que votre organisation remplit les conditions suivantes :

• Périmètre organisationnel : l’API Admin est limitée à l’organisation. Elle est disponible pour les organisations composées d’une seule équipe ou de plusieurs équipes avec les offres Canva Entreprise, Canva Districts et Canva Campus.
• Compte d’admin d’organisation : seuls les admins d’organisation peuvent créer et gérer des clients de l’API Admin dans les paramètres Canva.
• Ressources techniques internes ou externes : 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 ne peut pas créer d’intégration avec une API, le provisionnement SCIM est plus adapté pour automatiser la gestion des utilisateurs de votre organisation.
• Bonne connaissance de votre structure Canva : avant de créer votre intégration, assurez-vous de bien comprendre comment votre organisation, vos équipes et vos groupes sont organisés dans Canva.
• Authentification multifacteur (MFA) ou compte géré par authentification unique (SSO) : l’admin d’organisation qui configure l’API Admin doit avoir activé la MFA ou utiliser un compte géré par SSO. Le compte doit être géré ou détenu par l’organisation au nom de laquelle cette personne agit.

L’API Admin propose des points de terminaison pour :

• Utilisateurs, équipes et groupes : créer, consulter, mettre à jour et supprimer.
• Adhésions : ajouter ou retirer des personnes des équipes et des groupes, et définir leur rôle.
• Journaux d’audit : récupérer les événements du journal d’audit selon un calendrier.
• Invitations à une équipe : inviter des personnes dans une équipe (y compris des personnes extérieures à 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.

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

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

Pour obtenir des précisions 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 Canva avec votre équipe technique.

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

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

Vous pouvez également identifier l’admin d’organisation qui a créé, mis à jour ou supprimé un client d’API donné.

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

Les admins d’organisation peuvent utiliser l’API Admin pour inviter des personnes dans une équipe, y compris des collaborateurs externes à l’organisation.

À savoir

• Chaque invitation créée concerne une seule équipe et une seule adresse e-mail.
• Chaque invitation ne peut être utilisée qu’une fois et expire au bout de 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 elle.
• Gardez les liens d’invitation confidentiels. Un lien d’invitation ne fonctionne qu’avec l’adresse e-mail pour 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 invitée, la création d’une nouvelle invitation renvoie le même enregistrement d’invitation. Son expiration est alors repoussée de 30 jours à compter de la demande et le rôle associé est mis à jour en fonction du rôle demandé.

Pour connaître les détails des points de terminaison, consultez la documentation de l’API Admin Canva.

L’API Admin et SCIM permettent tous deux 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 ne peut pas créer une intégration d’API personnalisée, SCIM est plus adapté à vos besoins.

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 ne peut pas créer d’intégration avec une API, le provisionnement SCIM est plus adapté pour automatiser la gestion des utilisateurs de votre organisation.

Toutes les personnes de mon organisation doivent-elles utiliser la MFA ou le SSO pour accéder à l’API Admin ?

Non. Seul l’admin d’organisation qui configure l’API Admin doit avoir activé la MFA ou utiliser un compte géré par SSO. Le compte doit être géré ou détenu par l’organisation au nom de laquelle cette personne agit. Les autres membres de l’organisation n’ont pas besoin d’utiliser la MFA ou le SSO spécifiquement pour que l’API Admin fonctionne.

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

Oui. Les admins d’organisation peuvent utiliser l’API Admin pour inviter des personnes dans des équipes, y compris des collaborateurs 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 à nouveau un lien d’invitation existant sans créer une nouvelle invitation ?

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