Provisionera användare och grupper med SCIM

Notions SCIM-API gör att du kan göra följande:

• Skapa och ta bort medlemmar i din arbetsyta.

• Uppdatera en medlems profilinformation.

• Hämta medlemmarna i din arbetsyta.

• Hitta medlemmar via e-post eller namn.

• Skapa och ta bort grupper i din arbetsyta.

• Lägg till och ta bort medlemmar i en grupp.

• Hämta grupperna i din arbetsyta.

• Hitta grupper efter namn.

Vi har för närvarande stöd för Okta, OneLogin, Rippling och anpassade SCIM-applikationer. Om du använder en annan identitetsleverantör får du gärna höra av dig till oss. Se instruktioner för konfiguration av identitetsleverantör för specifika appar här →

För att använda SCIM med Notion:

• Din arbetsyta måste ha ett Enterprise-abonnemang.

• Din identitetsleverantör (IdP) måste ha stöd för protokollet SAML 2.0. Se instruktioner för konfiguration av identitetsleverantör för specifika appar här →

• En ägare av arbetsytan måste konfigurera SCIM för Notion-arbetsytan.

• Du måste ha verifierat ägarskap över en e-postdomän om du vill använda SCIM för att ändra en användares namn eller e-postadress. Läs mer om domänverifiering →

Endast organisationsägare med Enterprise-abonnemang kan generera och se SCIM API-tokens. För att skapa en SCIM API-token:

1. Öppna arbetsyteväxlaren och välj Hantera organisation. Du kan behöva Ställa in organisation först om du inte redan har gjort det. Läs mer här →

2. På fliken Allmänt i dina kontroller på organisationsnivå, välj > bredvid SCIM-provisionering.

När en arbetsyteägare lämnar arbetsytan eller deras roll ändras, kommer deras token att återkallas. När detta sker skickas ett automatiserat meddelande till de återstående arbetsyteägarna för att meddela dem att de behöver ersätta den återkallade token.

Dessutom kan aktiva tokens återkallas av vilken som helst av arbetsyteägarna i arbetsytan. För att återkalla en token, klicka på 🗑 bredvid respektive token.

Om en token återkallas måste du ersätta den i alla befintliga integreringar.

Varje SCIM-integrering och användarprovisionering som förlitar sig på den återkallade token kommer att inaktiveras tills den ersätts av en aktiv token.

För att styra om användare ska få inbjudningar till arbetsytor och grupper via e-post när de provisioneras via SCIM kan organisationsägare med Enterprise-abonnemang:

1. Öppna arbetsytaväxlaren och välj Hantera organisation.

2. På fliken Allmänt, aktivera Undertryck inbjudningsmeddelanden från SCIM-provisionering om du inte vill skicka e-postmeddelanden till användare.

För att provisionera en begränsad medlem via SCIM måste du ställa in SCIM-attributet 'role' till 'restricted_member':

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

För att överföra en sidgäst till en begränsad medlem via SCIM måste du använda POST /scim/v2/Users.

• GET /ServiceProviderConfig

  • GET

  • Hämta en beskrivning av de tillgängliga SCIM-specifikationsfunktionerna.

  • Definierat i avsnitt 5 i SCIM-protokollspecifikationen.

• GET /ResourceTypes

  • GET

  • Hämta en lista över de tillgängliga SCIM-resurstyperna.

  • Definierat i avsnitt 6 i SCIM-protokollspecifikationen.

Tabellen nedan beskriver mappningen mellan SCIM-användarattribut och Notions användarprofilfält. Organisationsägare väljer vilka attribut som ska skickas till Notion och kan när som helst uppdatera dessa attribut. Notion bearbetar de attribut du skickar via Notion SCIM-API:et för att förbättra upplevelsen av att etablera och hantera användare och grupper.

• GET /Users

  • GET

  • Hämta en paginerad lista över arbetsytamedlemmar.

  • Du kan paginera med parametrarna startIndex och count. Observera att startIndex är 1-indexerad och count har ett maxvärde på 100.

  • Du kan filtrera resultaten med parametern filter. Giltiga attribut att filtrera efter är email, given_name och family_name, t.ex. GET

  • Observera att given_name och family_name är skiftlägeskänsliga. E-post konverteras till gemener.

• GET /Users/

  • GET

  • Hämta en specifik arbetsytamedlem via dess Notion-användar-ID. Detta är ett UUID med 32 tecken i följande format: 00000000-0000-0000-0000-000000000000.

  • Observera att meta.created och meta.lastModified inte återspeglar meningsfulla tidsstämpelvärden.

• POST /Users

  • POST

  • Om användaren du lägger till redan har ett Notion-användarkonto med samma e-postadress, kommer de att läggas till i din arbetsyta.

  • Om användaren inte finns kommer ett anrop till detta att skapa en ny Notion-användare och sedan lägga till den användaren i din arbetsyta. De kommer att mappas till den Notion-användarprofil som skapas.

  • SCIM-API:et läser profilfotots egenskap vid skapande av användare, men inte vid framtida uppdateringar.

• PATCH /Users/

  • PATCH

  • Uppdatera genom en serie operationer och returnera den uppdaterade användarposten.

• PUT /Users/

  • PUT

  • Uppdatera och returnera den uppdaterade användarposten.

• DELETE /Users/

  • DELETE

  • Ta bort en användare från din arbetsyta. Användaren loggas ut från alla aktiva sessioner.

    • Användarkontot kan inte raderas via SCIM. Radering av kontot måste göras manuellt.

    • Att ta bort en användare från din arbetsyta kan även uppnås genom att sätta användarattributet active till false genom att skicka en PATCH /Users/ eller en PUT /Users/-förfrågan.

    • Arbetsytans ägare som skapade SCIM-bot-token kan inte tas bort via API:et. När en arbetsyteägare tas bort via SCIM-API:et kommer alla tokens de skapat att återkallas och alla integrationer som använder den boten kommer att sluta fungera.

• GET /Groups

  • GET

  • Hämta en paginerad lista över arbetsytans grupper.

  • Du kan paginera med parametrarna startIndex och count. Observera att startIndex är 1-indexerad och count har ett maxvärde på 100, t.ex. GET

    • Om paginering inte används returneras maximalt 100 arbetsgrupper i en förfrågan.

  • Du kan filtrera resultaten med parametern filter. Grupper kan filtreras efter deras attribut displayName, t.ex. GET

• GET /Groups/

  • GET

  • Hämta en specifik arbetsytans grupp via dess Notion-grupp-ID. Detta kommer att vara ett UUID med 32 tecken i följande format: 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • Skapa en ny arbetsgrupp.

• PATCH /Groups/

  • PATCH

  • Uppdatera en arbetsgrupp genom en serie operationer.

• PUT /Groups/

  • PUT

  • Uppdatera en arbetsgrupp.

• DELETE /Groups/

  • DELETE

  • Radera en arbetsgrupp.