Gebruikers en groepen inrichten via SCIM

Met de SCIM-API van Notion kun je het volgende doen:

• Leden maken en verwijderen in je workspace.

• Profielinformatie van een lid bijwerken.

• De leden in je workspace ophalen.

• Leden zoeken op e-mailadres of naam.

• Groepen maken en verwijderen in je workspace.

• Leden toevoegen aan en verwijderen uit een groep.

• De groepen in je workspace ophalen.

• Groepen zoeken op naam.

We ondersteunen momenteel Okta, OneLogin, Rippling en aangepaste SCIM-applicaties. Als je een andere Identity Provider gebruikt, laat het ons dan weten. Zie de instructies voor het instellen van de Identity Provider voor specifieke applicaties hier →

Om SCIM met Notion te gebruiken:

• Je werkruimte moet op een Enterprise-abonnement zitten.

• Je Identity Provider (IdP) moet het SAML 2.0-protocol ondersteunen. Zie de instructies voor het instellen van de Identity Provider voor specifieke applicaties hier →

• Een workspace-eigenaar moet SCIM configureren voor de Notion-workspace.

• Je moet het eigendom van een e-maildomein hebben geverifieerd als je SCIM wilt gebruiken om de naam of het e-mailadres van een gebruiker te wijzigen. Meer informatie over domeinverificatie →

Alleen organisatie-eigenaren met een Enterprise-abonnement kunnen SCIM API-tokens genereren en bekijken. Een SCIM API-token aanmaken:

1. Open de workspace-switcher en selecteer Organisatie beheren. Mogelijk moet je eerst Organisatie instellen als je dat nog niet hebt gedaan. Meer informatie vind je hier →

2. Selecteer in het tabblad Algemeen van je instellingen op organisatieniveau > naast SCIM-provisioning.

Wanneer een workspace-eigenaar de workspace verlaat of diens rol wordt gewijzigd, wordt het token ingetrokken. Wanneer dit gebeurt, wordt er een geautomatiseerd bericht naar de overige workspace-eigenaren gestuurd om hen te laten weten dat ze het ingetrokken token moeten vervangen.

Daarnaast kunnen actieve tokens worden ingetrokken door een van de workspace-eigenaren in de workspace. Klik op de 🗑 naast het betreffende token om een token in te trekken.

Als een token is ingetrokken, moet je dit vervangen in alle bestaande integraties.

Elke SCIM-integratie en gebruikersprovisioning die afhankelijk is van het ingetrokken token wordt uitgeschakeld totdat het is vervangen door een actief token.

Om te bepalen of gebruikers uitnodigingen voor workspaces en groepen via e-mail ontvangen wanneer ze worden geprovisioneerd via SCIM, kunnen eigenaren van een Enterprise-abonnement:

1. Open de workspace-switcher en selecteer Organisatie beheren.

2. Schakel in het tabblad Algemeen de optie Uitnodigen e-mails van SCIM-provisioning onderdrukken in als je geen e-mails naar gebruikers wilt sturen.

Om een beperkt lid via SCIM in te richten, moet je het SCIM-'role'-attribuut instellen op 'restricted_member':

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

Om een pagina-gast om te zetten naar een beperkt lid via SCIM, moet je POST /scim/v2/Users gebruiken.

• GET /ServiceProviderConfig

  • GET

  • Haal een beschrijving op van de beschikbare SCIM-functies.

  • Gedefinieerd in Sectie 5 van de SCIM-protocolspecificatie.

• GET /ResourceTypes

  • GET

  • Haal een lijst op van de beschikbare SCIM-resourcetypen.

  • Gedefinieerd in Sectie 6 van de SCIM-protocolspecificatie.

De onderstaande tabel geeft een overzicht van de mapping tussen SCIM-gebruikerskenmerken en Notion-gebruikersprofielvelden. Organisatie-eigenaren kiezen welke kenmerken naar Notion worden verzonden en kunnen deze kenmerken op elk gewenst moment bijwerken. Notion verwerkt de kenmerken die je via de Notion SCIM-API verzendt om de ervaring van het inrichten en beheren van gebruikers en groepen te verbeteren.

• GET /Users

  • GET

  • Haal een gepagineerde lijst met workspaceleden op.

  • Je kunt pagineren met de parameters startIndex en count. Merk op dat startIndex 1-geïndexeerd is en count een maximum van 100 heeft.

  • Je kunt de resultaten filteren met de parameter filter. Geldige kenmerken om op te filteren zijn e-mail, given_name en family_name, bijv. GET

  • Let op dat given_name en family_name hoofdlettergevoelig zijn. E-mail wordt omgezet naar kleine letters.

• GET /Users/

  • GET

  • Haal een specifiek lid op uit je Notion werkruimte via de Notion user-ID. Dit is een UUID van 32 tekens in de volgende indeling: 00000000-0000-0000-0000-000000000000.

  • Let op dat meta.created en meta.lastModified geen betekenisvolle tijdstempelwaarden weergeven.

• POST /Users

  • POST

  • Als de gebruiker die je toevoegt al een Notion-account heeft met dezelfde e-mail, wordt deze toegevoegd aan je werkruimte.

  • Als de gebruiker niet bestaat, zal het aanroepen hiervan een nieuwe Notion-gebruiker aanmaken en die gebruiker vervolgens toevoegen aan je werkruimte. De gebruiker wordt gekoppeld aan het Notion-gebruikersprofiel dat wordt aangemaakt.

  • De SCIM-API leest de profielfoto-eigenschap bij het aanmaken van een gebruiker, maar niet bij toekomstige updates.

• PATCH /Users/

  • PATCH

  • Bijwerken via een reeks bewerkingen en het bijgewerkte gebruikersrecord retourneren.

• PUT /Users/

  • PUT

  • Bijwerken en het bijgewerkte gebruikersrecord retourneren.

• DELETE /Users/

  • DELETE

  • Verwijder een gebruiker uit je werkruimte. De gebruiker wordt uitgelogd bij alle actieve sessies.

    • Je account kan niet via SCIM worden verwijderd. Het verwijderen van je account moet handmatig worden uitgevoerd.

    • Het verwijderen van een gebruiker uit je werkruimte kan ook worden bereikt door het gebruikerskenmerk active in te stellen op false door een PATCH /Users/ of een PUT /Users/ verzoek te sturen.

    • De werkruimteeigenaar die het SCIM-bot-token heeft gemaakt, kan niet via de API worden verwijderd. Wanneer een werkruimteeigenaar via de SCIM-API wordt verwijderd, worden alle tokens die hij heeft gemaakt ingetrokken en werken alle integraties met die bot niet meer.

• GET /Groups

  • GET

  • Haal een gepagineerde lijst met werkruimtegroepen op.

  • Je kunt pagineren met de parameters startIndex en count. Let op: startIndex is 1-geïndexeerd en count heeft een maximum van 100, bijv. GET

    • Als paginering niet wordt gebruikt, worden er maximaal 100 werkruimtegroepen in een verzoek geretourneerd.

  • Je kunt de resultaten filteren met de parameter filter. Groepen kunnen worden gefilterd op hun displayName-kenmerk, bijv. GET

• GET /Groups/

  • GET

  • Haal een specifieke werkruimtegroep op via de Notion-groep-ID. Dit is een UUID van 32 tekens in de volgende indeling: 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • Een nieuwe werkruimtegroep maken.

• PATCH /Groups/

  • PATCH

  • Een werkruimtegroep bijwerken via een reeks bewerkingen.

• PUT /Groups/

  • PUT

  • Een werkruimtegroep bijwerken.

• DELETE /Groups/

  • DELETE

  • Een werkruimtegroep verwijderen.