Provisionner des utilisateurs et des groupes avec SCIM

Avec l'API SCIM de Notion, vous pouvez :

• Créer et supprimer des membres dans votre espace de travail.

• Mettre à jour les informations de profil d'un membre.

• Extraire les membres de votre espace de travail.

• Rechercher des membres par nom ou adresse e‑mail.

• Créer et supprimer des groupes dans votre espace de travail.

• Ajouter et enlever des membres dans un groupe.

• Extraire les groupes de votre espace de travail.

• Rechercher des groupes par nom.

Nous prenons actuellement en charge Okta, OneLogin, Rippling et les applications SCIM personnalisées. Si vous utilisez à un autre fournisseur d'identité, dites-le nous. Voir les instructions concernant la configuration du fournisseur d'identité pour des applications spécifiques ici →

Pour utiliser le SCIM avec Notion :

• Votre espace de travail doit être au forfait Entreprise.

• Votre fournisseur d'identité (IdP) doit prendre en charge le protocole SAML 2.0. Voir les instructions concernant la configuration du fournisseur d'identité pour des applications spécifiques ici →

• Un propriétaire d'espace de travail doit configurer le SCIM pour l'espace Notion.

• Si vous souhaitez utiliser SCIM pour modifier le nom ou l'adresse e-mail d'un utilisateur, vous devez avoir vérifié la propriété de son domaine de messagerie. En savoir plus sur la vérification des domaines →

Seuls les propriétaires d'organisations disposant du forfait Enterprise peuvent générer et afficher leurs jetons API SCIM. Pour créer un jeton d'API SCIM :

1. Ouvrez le sélecteur d'espaces de travail et sélectionnez Gérer l'organisation. Vous devrez peut-être d'abord configurer l'organisation si ce n'est pas déjà fait. En savoir plus ici →

2. Dans l'onglet Général des paramètres d'organisation, sélectionnez > à côté de Provisionnement SCIM.

Lorsqu'un propriétaire d'espace de travail quitte cet espace ou change de rôle, son jeton est révoqué. Dans ce cas, nous envoyons automatiquement un message aux propriétaires restants pour les aviser qu'un jeton révoqué doit être remplacé.

En outre, les jetons actifs peuvent être révoqués par n'importe quel propriétaire d'espace de travail. Pour révoquer un jeton, cliquez sur 🗑 à côté du jeton.

Si un jeton est révoqué, vous devrez le remplacer dans toutes les intégrations qui l'utilisent.

Toutes les intégrations SCIM et automatisations de création d'utilisateurs basées sur le jeton révoqué seront désactivées jusqu'au remplacement avec un nouveau jeton.

Pour choisir si les utilisateurs provisionnés par SCIM recevront des e-mails les invitant à intégrer des espaces de travail et des groupes, les propriétaires d'organisations du forfait Entreprise peuvent :

1. Ouvrez le sélecteur d'espaces de travail et sélectionnez Gérer l'organisation.

2. Dans l'onglet Général, activez l'option Supprimer les e-mails d'invitation du provisionnement SCIM si vous ne souhaitez pas envoyer d'e-mails aux utilisateurs.

Pour approvisionner un· e membre restreint·e via SCIM, vous devez définir l'attribut « role » de SCIM sur « restricted_member » :

"urn:ietf:params:scim:schemas:extension:notion:2.0:User": { role: string // "owner" | "membership_admin" | "member" | "restricted_member" }

Pour faire passer un·e invité·e de page à un·e membre restreint·e via SCIM, vous devez utiliser POST /scim/v2/Users.

• GET /ServiceProviderConfig

  • GET

  • Renvoie une description des caractéristiques disponibles de la spécification SCIM.

  • Définie dans la section 5 de la spécification du protocole SCIM.

• GET /ResourceTypes

  • GET

  • Renvoie la liste des types de ressources SCIM disponibles.

  • Définie dans la section 6 de la spécification du protocole SCIM.

La table ci-dessous affiche la correspondance entre les attributs utilisateur SCIM et les champs du profil utilisateur Notion. Les propriétaires d'organisation choisissent les attributs à envoyer à Notion et peuvent mettre à jour ces attributs à tout moment. Notion traite les attributs que vous envoyez via l'API SCIM de Notion pour améliorer l'expérience de provisionnement et de gestion des utilisateurs et des groupes.

• GET /Users

  • GET

  • Renvoie une liste paginée des membres de l'espace de travail.

  • Vous pouvez paginer avec les paramètres startIndex et count. Le paramètre startIndex démarre à 1 (1-indexed) et peut aller jusqu'à 100.

  • Vous pouvez filtrer les résultats avec le paramètre filter. Les attributs valides à filtrer sont email, given_nameet family_name, par exemple GET

  • Important : les valeurs des paramètres given_name et family_name sont sensibles à la casse. L'adresse e‑mail est convertie en minuscules.

• GET /Users/

  • GET

  • Renvoie un membre de l'espace de travail par son identifiant utilisateur Notion. L'identifiant est un UUID de 32 caractères au format suivant : 00000000-0000-0000-0000-000000000000.

  • Notez que les paramètres meta.created et meta.lastModified ne sont pas des valeurs d'horodatage.

• POST /Utilisateurs

  • POST

  • Si la personne que vous ajoutez possède déjà un compte Notion avec la même adresse e‑mail, elle sera ajoutée à votre espace de travail.

  • Si l'utilisateur n'existe pas, l'appel de cette fonction créera un nouvel utilisateur Notion, puis l'ajoutera à votre espace de travail. Les attributs d'utilisateur seront ajoutés dans les champs correspondants du nouveau profil utilisateur Notion.

  • L'API SCIM lira la propriété de photo de profil lors de la création de l'utilisateur, mais pas lors des mises à jour ultérieures.

• PATCH /Users/

  • PATCH

  • Met à jour à travers une série d'opérations et renvoie l'enregistrement utilisateur mis à jour.

• PUT /Users/

  • PUT

  • Met à jour et renvoie l'objet utilisateur mis à jour.

• DELETE /Users/

  • DELETE

  • Supprime un utilisateur de votre espace de travail. Le compte est déconnecté de toutes les sessions actives.

    • Remarque : le compte utilisateur ne peut pas être supprimé avec SCIM. Vous devez supprimer un compte manuellement.

    • Pour supprimer un utilisateur de votre espace de travail, vous pouvez également définir l'attribut utilisateur actif sur false en envoyant une requête PATCH /Users/ ou une requête PUT /Users/.

    • Note : le propriétaire d'espace de travail qui a créé le jeton SCIM ne peut pas être supprimé par API. Lorsqu'un propriétaire d'espace de travail est supprimé via l'API SCIM, tous les jetons qu'il ou elle a créés sont révoqués et toutes les intégrations qui utilisent ces jetons sont interrompues.

• GET /Groups

  • GET

  • Renvoie une liste paginée des groupes de l'espace de travail.

  • Vous pouvez paginer avec les paramètres startIndex et count. Notez que le paramètre startIndex démarre à 1 (1-indexed) et peut aller jusqu'à 100. Par exemple GET

    • Si la pagination n'est pas utilisée, la requête renverra un maximum de 100 groupes de l'espace de travail.

  • Vous pouvez filtrer les résultats avec le paramètre filter. Les groupes peuvent être filtrés par l'attribut displayName. Par exemple GET

• GET /Groups/

  • GET

  • Renvoie un groupe de l'espace de travail par son identifiant de groupe Notion. L'identifiant est un UUID de 32 caractères au format suivant : 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • Crée un nouveau groupe dans l'espace de travail.

• PATCH /Groups/

  • PATCH

  • Met à jour un groupe à travers une série d'opérations.

• PUT /Groups/

  • PUT

  • Met à jour un groupe de l'espace de travail.

• DELETE /Groups/

  • DELETE

  • Supprime un groupe de l'espace de travail.