Configurer et utiliser l’API Canva Admin

Vous pouvez utiliser l’API d’administration Canva pour automatiser la gestion de votre organisation depuis vos propres systèmes. Gérez les membres, 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 avec une ou plusieurs équipes.

Avant de configurer l’API d’administration, assurez-vous que votre organisation répond aux conditions suivantes :

• Niveau de l’organisation : l’API d’administration s’applique à l’organisation. Elle est disponible pour les organisations avec une ou plusieurs équipes qui disposent d’un abonnement Canva Entreprise, Canva Districts ou Canva Campus.
• Compte admin d’organisation : seuls les admins d’organisation peuvent créer et gérer des clients de l’API d’administration dans les paramètres Canva.
• Équipe d’ingénierie interne ou externe : votre organisation doit disposer de ressources d’ingénierie pour développer 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 à une API, le provisionnement SCIM est une meilleure solution pour automatiser la gestion des membres de votre organisation.
• Connaissance de votre structure Canva : avant de développer votre intégration, assurez-vous de bien comprendre comment votre organisation, vos équipes et vos groupes sont structurés dans Canva.
• Authentification multifacteur (MFA) ou compte géré par authentification unique (SSO) : l’admin d’organisation qui configure l’API d’administration doit avoir activé la MFA ou disposer d’un compte géré par authentification unique. Le compte doit être géré ou détenu par l’organisation au nom de laquelle cette personne agit.

L’API d’administration propose des points de terminaison pour :

• Membres, é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 leurs rôles.
• Journaux d’audit : récupérer les événements du journal d’audit selon un calendrier défini.
• 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 d’administration et l’utilise pour appeler l’API.

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

Pour en savoir plus 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 d’administration Canva avec votre équipe d’ingénierie.

Les actions effectuées via l’API d’administration sont attribuées au client de l’API d’administration, et non à l’admin qui l’a appelé.

Dans les journaux d’audit, le champ « Acteur » affiche le nom et l’identifiant du client de l’API d’administration. 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 spécifique.

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

Les admins d’organisation peuvent utiliser l’API d’administration pour inviter des personnes dans une équipe, y compris des collaborateurs 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 au bout de 30 jours.
• Selon votre configuration, Canva n’envoie pas toujours automatiquement un e-mail à la personne invitée. Si nécessaire, partagez directement le lien d’invitation avec elle.
• Gardez les liens d’invitation privés. 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, réinitialise son expiration à 30 jours après la demande et met à jour le rôle de la personne invitée selon le rôle demandé.

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

L’API d’administration et SCIM peuvent toutes deux prendre en charge le provisionnement des membres.

L’API d’administration permet de gérer d’autres aspects de l’organisation Canva que le provisionnement des membres, 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 membres ou si votre équipe ne peut pas développer une intégration API personnalisée, SCIM répondra mieux à vos besoins.

Mon organisation a-t-elle besoin d’une personne spécialiste du développement pour utiliser l’API d’administration ?

Oui. Pour utiliser l’API d’administration, votre organisation doit disposer de ressources d’ingénierie internes ou externes pour développer 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 à une API, le provisionnement SCIM est une meilleure solution pour automatiser la gestion des membres de votre organisation.

Tous les membres de mon organisation doivent-ils utiliser la MFA ou l’authentification unique pour accéder à l’API d’administration ?

Non. Seul l’admin d’organisation qui configure l’API d’administration doit avoir activé la MFA ou disposer d’un compte géré par authentification unique. 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 l’authentification unique pour que l’API d’administration fonctionne.

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

Oui. Les admins d’organisation peuvent utiliser l’API d’administration 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.

Peut-on 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.