Provisionér brugere og gruppér med SCIM

Notions SCIM-API giver dig mulighed for at gøre følgende:

• Opret og fjern medlemmer i dit arbejdsområde.

• Opdater medlems profiloplysninger.

• Hent medlemmerne i dit arbejdsområde.

• Find medlemmer efter e-mail eller navn.

• Opret og fjern gruppér i dit arbejdsområde.

• Tilføj og fjern medlemmer i en gruppér.

• Hent gruppér i dit arbejdsområde.

• Find gruppér efter navn.

Vi understøtter i øjeblikket Okta, OneLogin, Rippling og brugerdefinerede SCIM-applikationer. Hvis du bruger en anden identitetsudbyder, må du meget gerne give os besked. Se instruktioner til opsætning af identitetsudbyder for specifikke apps her →

For at bruge SCIM med Notion:

• Dit arbejdsområde skal være på et Enterprise-abonnement.

• Din identitetsudbyder (IdP) skal understøtte SAML 2.0-protokollen. Se instruktioner til opsætning af identitetsudbyder for specifikke apps her →

• En arbejdsområdeejer skal konfigurere SCIM til Notion-arbejdsområdet.

• Du skal have bekræftet ejerskab over et e-maildomæne, hvis du vil bruge SCIM til at ændre en brugers navn eller e-mailadresse. Læs mere om domænebekræftelse →

Kun organisationsejere af et Enterprise-abonnement kan generere og se SCIM API-tokens. Sådan opretter du et SCIM API-token:

1. Åbn arbejdsområdeskifteren, og vælg Administrér organisation. Du skal muligvis Konfigurér organisation først, hvis du ikke allerede har gjort det. Lær mere her →

2. I fanen Generelt i dine kontroller på organisationsniveau skal du vælge > ud for SCIM-provisionering.

Når en arbejdsområdeejer forlader arbejdsområdet, eller vedkommendes rolle ændres, vil deres token blive tilbagekaldt. Når dette sker, sendes en automatisk besked til de resterende arbejdsområdeejere for at give dem besked om at erstatte det tilbagekaldte token.

Derudover kan aktive tokens tilbagekaldes af enhver af arbejdsområdeejerne i arbejdsområdet. For at tilbagekalde et token skal du klikke på 🗑 ud for det respektive token.

Hvis et token tilbagekaldes, skal du erstatte det i alle eksisterende integrationer.

Enhver SCIM-integration og brugerklargøring, der er afhængig af det tilbagekaldte token, vil blive deaktiver, indtil det erstattes af et aktivt token.

For at styre, om brugere modtager invitationer til arbejdsområder og gruppér via e-mail, når de klargøres via SCIM, kan organisationsejere med et Enterprise-abonnement:

1. Åbn arbejdsområdeskifteren, og vælg Administrér organisation.

2. I fanen Generelt skal du slå Undertryk inviter-e-mail fra SCIM provisionering til, hvis du ikke ønsker at sende e-mails til brugere.

For at klargøre et begrænset medlem via SCIM skal du indstille SCIM-attributten 'role' til 'restricted_member':

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

For at overføre en side-gæst til et begrænset medlem via SCIM skal du bruge POST /scim/v2/Users.

• GET /ServiceProviderConfig

  • GET

  • Hent en beskrivelse af de funktioner i SCIM-specifikationen, der er tilgængelige.

  • Defineret i Section 5 of the SCIM Protocol Specification.

• GET /ResourceTypes

  • GET

  • Hent en liste over de tilgængelige SCIM-ressourcetyper.

  • Defineret i Section 6 of the SCIM Protocol Specification.

Tabel nedenfor skitserer tilknytningen mellem SCIM-brugerattributter og Notion-brugerprofilfelter. Organisationsejere vælger, hvilke attributter der skal sendes til Notion, og kan til enhver tid opdatere disse attributter. Notion behandler de attributter, du sender via Notion SCIM API'et, for at forbedre oplevelsen af provisionering og administration af brugere og gruppér.

• GET /Users

  • GET

  • Hent en pagineret liste over medlemmer af arbejdsområdet.

  • Du kan paginere ved hjælp af parametrene startIndex og count. Bemærk, at startIndex er 1-indekseret, og count har et maksimum på 100.

  • Du kan filtrere resultaterne med parameteren filter. Gyldige attributter at filtrere efter er email, given_name og family_name, f.eks. GET

  • Bemærk, at given_name og family_name skelner mellem store og små bogstaver. E-mail konverteres til små bogstaver.

• GET /Users/

  • GET

  • Hent et specifikt arbejdsområdemedlem via dets Notion-bruger-id. Dette vil være en UUID med 32 tegn i følgende format: 00000000-0000-0000-0000-000000000000.

  • Bemærk, at meta.created og meta.lastModified ikke afspejler meningsfulde tidsstempelværdier.

• POST /Users

  • POST

  • Hvis den bruger, du tilføjer, allerede har en Notion-brugerkonto med samme e-mail, bliver vedkommende tilføjet til dit arbejdsområde.

  • Hvis brugeren ikke eksisterer, vil et kald til dette oprette en ny Notion-bruger og derefter tilføje denne bruger til dit arbejdsområde. De vil blive knyttet til den Notion-brugerprofil, der oprettes.

  • SCIM API'et læser profilfotoegenskaben ved brugeroprettelse, men ikke ved fremtidige opdateringer.

• PATCH /Users/

  • PATCH

  • Opdaterer gennem en række operationer og returnerer den opdaterede brugerpost.

• PUT /Users/

  • PUT

  • Opdaterer og returnerer den opdaterede brugerpost.

• DELETE /Users/

  • DELETE

  • Fjern en bruger fra dit arbejdsområde. Brugeren logges ud af alle aktive sessioner.

    • Brugerkontoen kan ikke slettes via SCIM. Kontosletning skal foretages manuelt.

    • Fjernelse af en bruger fra dit arbejdsområde kan også opnås ved at indstille brugerattributten active til false ved at sende en PATCH /Users/ eller en PUT /Users/ anmodning.

    • Arbejdsområdets ejer, der oprettede SCIM-bot-tokenet, kan ikke fjernes via API'et. Når en ejer af et arbejdsområde fjernes via SCIM API'et, vil alle tokens, de har oprettet, blive tilbagekaldt, og alle integrationer, der bruger den bot, vil blive afbrudt.

• GET /Groups

  • GET

  • Hent en pagineret liste over grupper i arbejdsområdet.

  • Du kan paginere ved hjælp af parametrene startIndex og count. Bemærk, at startIndex er 1-indekseret, og count har et maksimum på 100, f.eks. GET

    • Hvis paginering ikke bruges, returneres maksimalt 100 grupper i arbejdsområdet i en anmodning.

  • Du kan filtrere resultaterne med parameteren filter. Grupper kan filtreres efter deres displayName-attribut, f.eks. GET

• GET /Groups/

  • GET

  • Hent en specifik gruppe i arbejdsområdet via dens Notion-gruppe-id. Dette vil være en UUID på 32 tegn i følgende format: 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • Opret en ny gruppe i arbejdsområdet.

• PATCH /Groups/

  • PATCH

  • Opdater en gruppe i arbejdsområdet gennem en række operationer.

• PUT /Groups/

  • PUT

  • Opdater en gruppe i arbejdsområdet.

• DELETE /Groups/

  • DELETE

  • Slet en gruppe i arbejdsområdet.