Configurer et utiliser l’API Canva Admin

Vous pouvez utiliser l’API Admin de 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 des journaux d’audit sans devoir effectuer ces tâches manuellement dans Canva.

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

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

• Structure de l’organisation : l’API Admin est réservée à l’organisation. Elle est disponible pour les organisations à une ou plusieurs équipes disposant d’un abonnement Canva Enterprise, Canva Districts ou Canva Campus.
• Compte 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 d’ingénierie interne ou externe : votre organisation doit disposer de ressources d’ingénierie 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 à partir d’une API, le provisionnement SCIM est une meilleure solution pour automatiser la gestion des utilisateurs dans 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 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 authentification unique. 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 gérer :

• les utilisateurs, les équipes et les groupes : création, consultation, mise à jour et suppression.
• les adhésions : ajout ou retrait de personnes dans les équipes et les groupes, et attribution de rôles.
• les journaux d’audit : récupération des événements des journaux d’audit selon un calendrier.
• les invitations à rejoindre une équipe : invitation de personnes dans une équipe, y compris de personnes externes à votre organisation, consultation des invitations en attente, récupération d’un lien d’invitation existant à partir de l’adresse e-mail exacte et annulation des invitations.

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

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 en savoir plus sur l’authentification des requêtes API et l’utilisation des jetons porteurs OAuth 2.0, transmettez la documentation sur l’authentification de l’API Admin de Canva à votre équipe d’ingénierie.

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

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

Vous pouvez également identifier l’administrateur de l’organisation qui a créé, mis à jour ou supprimé un client API en particulier.

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

Les administrateurs de l’organisation peuvent utiliser l’API Admin pour inviter des personnes dans une équipe, y compris des collaborateurs externes à votre 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’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 qu’avec l’adresse e-mail pour laquelle il a été créé.
• Les paramètres d’invitation et de domaine déjà configurés 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 repoussée à 30 jours à compter de la demande et le rôle associé 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.

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

L’API Admin prend en charge d’autres aspects de la gestion d’une organisation Canva, en plus du provisionnement des utilisateurs. Cela comprend 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 d’intégration API personnalisée, SCIM est une meilleure solution pour répondre à vos besoins.

Mon organisation a-t-elle besoin d’une personne spécialisée en développement pour utiliser l’API Admin ?

Oui. Pour utiliser l’API Admin, votre organisation doit disposer de ressources d’ingénierie 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 à partir d’une API, le provisionnement SCIM est une meilleure solution pour automatiser la gestion des utilisateurs dans votre organisation.

Toutes les personnes de mon organisation doivent-elles utiliser la MFA ou l’authentification unique pour que l’API Admin fonctionne ?

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 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 Admin fonctionne.

Mon organisation peut-elle inviter des collaborateurs 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 collaborateurs externes. Les paramètres d’invitation et de domaine déjà configurés 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.