Klargjøre brukere og grupper med SCIM

Notions SCIM-API lar deg gjøre følgende:

• Opprett og fjern medlemmer i arbeidsområdet ditt.

• Oppdater profilinformasjonen til et medlem.

• Hent medlemmene i arbeidsområdet ditt.

• Finn medlemmer etter e-post eller navn.

• Opprett og fjern grupper i arbeidsområdet ditt.

• Legg til og fjern medlemmer i en gruppe.

• Hent gruppene i arbeidsområdet ditt.

• Finn grupper etter navn.

Vi støtter for øyeblikket Okta, OneLogin, Rippling og egendefinerte SCIM-applikasjoner. Hvis du bruker en annen identitetsleverandør, må du gi oss beskjed. Se instruksjoner for oppsett av identitetsleverandør for spesifikke apper her →

For å bruke SCIM med Notion:

• Arbeidsområdet ditt må være på et Enterprise-abonnement.

• Identitetsleverandøren din (IdP) må støtte SAML 2.0-protokollen. Se instruksjoner for oppsett av identitetsleverandør for spesifikke apper her →

• En eier av arbeidsområdet må konfigurere SCIM for Notion-arbeidsområdet.

• Du må ha bekreftet eierskap over et e-postdomene hvis du vil bruke SCIM til å endre et brukernavn eller en e-postadresse. Lær mer om domeneverifisering →

Kun organisasjonseiere med Enterprise-abonnement kan generere og se SCIM API-tokener. Slik oppretter du et SCIM API-token:

1. Åpne arbeidsområdevelgeren og velg Administrer organisasjon. Du må kanskje Sett opp organisasjon først hvis du ikke allerede har gjort det. Lær mer her →.

2. I fanen Generelt i kontrollene på organisasjonsnivå, velg > ved siden av SCIM-klargjøring.

Når en arbeidsområdeeier forlater arbeidsområdet eller rollen deres endres, vil tokenet deres bli opphevet. Når dette skjer, vil en automatisert melding bli sendt til de gjenværende arbeidsområdeeierne for å varsle dem om å erstatte det opphevde tokenet.

I tillegg kan aktive tokener oppheves av alle arbeidsområdeeierne i arbeidsområdet. For å oppheve et token, klikk på 🗑 ved siden av det respektive tokenet.

Hvis et token blir opphevet, må du erstatte det i alle eksisterende integrasjoner.

Enhver SCIM-integrasjon og brukerklargjøring som er avhengig av det opphevde tokenet, vil bli deaktivert til det er erstattet av et aktivt token.

For å kontrollere om brukere skal motta invitasjoner til arbeidsområder og grupper via e-post når de klargjøres via SCIM, kan organisasjonseiere med Enterprise-abonnement:

1. Åpne arbeidsområdebytteren og velg Administrer organisasjon.

2. I fanen Generelt, slå på Undertrykk invitasjonse-poster fra SCIM-klargjøring hvis du ikke vil sende e-poster til brukere.

For å klargjøre et begrenset medlem gjennom SCIM, må du sette SCIM-attributtet «role» til «restricted_member»:

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

For å overføre en sidegjest til et begrenset medlem gjennom SCIM, må du bruke POST /scim/v2/Users.

• GET /ServiceProviderConfig

  • GET

  • Hent en beskrivelse av de tilgjengelige SCIM-spesifikasjonsfunksjonene.

  • Definert i seksjon 5 i SCIM-protokollspesifikasjonen.

• GET /ResourceTypes

  • GET

  • Hent en liste over de tilgjengelige SCIM-ressurstypene.

  • Definert i seksjon 6 i SCIM-protokollspesifikasjonen.

Tabellen nedenfor skisserer tilordningen mellom SCIM-brukerattributter og Notion-brukerprofilfelt. Organisasjonseiere velger hvilke attributter som skal sendes til Notion, og kan oppdatere slike attributter når som helst. Notion behandler attributtene du sender gjennom Notion SCIM API for å forbedre opplevelsen av klargjøring og administrasjon av brukere og grupper.

• GET /Users

  • GET

  • Hent en paginert liste over arbeidsområdemedlemmer.

  • Du kan paginere ved å bruke parameterne startIndex og count. Merk at startIndex er 1-indeksert og count har en maksimumsverdi på 100.

  • Du kan filtrere resultatene med filter-parameteren. Gyldige attributter å filtrere etter er email, given_name og family_name, f.eks. GET

  • Merk at given_name og family_name skiller mellom store og små bokstaver. E-post konverteres til små bokstaver.

• GET /Users/

  • GET

  • Hent et spesifikt medlem av arbeidsområdet ved hjelp av Notion-bruker-ID-en. Dette vil være en UUID med 32 tegn i følgende format: 00000000-0000-0000-0000-000000000000.

  • Merk at meta.created og meta.lastModified ikke reflekterer meningsfulle tidsstempelverdier.

• POST /Users

  • POST

  • Hvis brukeren du legger til allerede har en Notion-brukerkonto med samme e-postadresse, vil vedkommende bli lagt til i arbeidsområdet ditt.

  • Hvis brukeren ikke eksisterer, vil et kall til dette opprette en ny Notion-bruker og deretter legge til denne brukeren i arbeidsområdet ditt. De vil bli tilknyttet Notion-brukerprofilen som opprettes.

  • SCIM-API-et vil lese profilbildeegenskapen ved opprettelse av bruker, men ikke ved fremtidige oppdateringer.

• PATCH /Users/

  • PATCH

  • Oppdater gjennom en serie operasjoner, og returnerer den oppdaterte brukerposten.

• PUT /Users/

  • PUT

  • Oppdater, og returnerer den oppdaterte brukerposten.

• DELETE /Users/

  • DELETE

  • Fjern en bruker fra arbeidsområdet ditt. Brukeren blir logget ut av alle aktive økter.

    • Kontoen kan ikke slettes via SCIM. Kontosletting må gjøres manuelt.

    • Fjerning av en bruker fra arbeidsområdet ditt kan også oppnås ved å sette active-brukerattributtet til false ved å sende en PATCH /Users/ eller en PUT /Users/-forespørsel.

    • Eieren av arbeidsområdet som opprettet SCIM-bot-tokenet, kan ikke fjernes via API. Når arbeidsområdets eier fjernes via SCIM API, vil alle tokener de har opprettet bli tilbakekalt, og alle integrasjoner som bruker boten, slutte å fungere.

• GET /Groups

  • GET

  • Hent en paginert liste over arbeidsområdegrupper.

  • Du kan paginere ved hjelp av startIndex- og count-parameterne. Merk at startIndex er 1-indeksert og count har en maksimumsverdi på 100, f.eks. GET

    • Hvis paginering ikke brukes, vil maksimalt 100 arbeidsområdegrupper bli returnert i en forespørsel.

  • Du kan filtrere resultatene med filter-parameteren. Grupper kan filtreres etter displayName-attributtet, f.eks. GET

• GET /Groups/

  • GET

  • Hent en spesifikk arbeidsområdegruppe ved hjelp av Notion-gruppe-ID-en. Dette vil være en UUID med 32 tegn i følgende format: 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • Opprett en ny arbeidsområdegruppe.

• PATCH /Groups/

  • PATCH

  • Oppdater en arbeidsområdegruppe gjennom en serie operasjoner.

• PUT /Groups/

  • PUT

  • Oppdater en arbeidsområdegruppe.

• DELETE /Groups/

  • DELETE

  • Slett en arbeidsområdegruppe.