SCIM-Bereitstellung für Benutzer/-innen und Gruppen

Die SCIM-API von Notion ermöglicht dir Folgendes:

• Workspace-Mitglieder erstellen und entfernen

• Profilinformationen von Mitgliedern ändern

• Workspace-Mitglieder abrufen

• Mitglieder anhand von E-Mail-Adresse und Namen suchen

• Workspace-Gruppen erstellen und entfernen

• Gruppenmitglieder hinzufügen und entfernen

• Workspace-Gruppe abrufen

• Gruppen anhand von Namen suchen

Wir unterstützen derzeit Okta, OneLogin, Rippling und individuelle SCIM-Anwendungen. Falls du einen anderen Identitätsanbieter nutzt, teile uns das bitte mit. Eine Anleitung zum Einrichten von Identitätsanbietern für bestimmte Apps findest du hier →

So verwendest du SCIM mit Notion:

• Der Workspace muss zu einem Enterprise Plan gehören.

• Dein Identitätsanbieter (IdP) muss das SAML 2.0 Protokoll unterstützen. Eine Anleitung zum Einrichten von Identitätsanbietern für bestimmte Apps findest du hier →

• SCIM muss von den Workspace-Besitzer/-innen für den Notion-Workspace konfiguriert werden.

• Du musst den Besitz einer E-Mail-Domain verifiziert haben, wenn du SCIM verwenden möchtest, um die Namen oder die E-Mail-Adresse von Nutzer/-innen zu ändern. Erfahre mehr über die Domain-Verifizierung →

Nur Organisationsbesitzer/-innen mit Enterprise-Abo können SCIM-API-Token generieren und anzeigen. So erstellst du ein SCIM-API-Token:

1. Öffne den Workspace Switcher und wähle Organisation verwalten aus. Du musst möglicherweise zuerst eine Organisation einrichten, falls du dies noch nicht getan hast. Erfahre mehr darüber hier →

2. Wähle im Tab Allgemein der Steuerelemente auf Organisationsebene > neben SCIM-Bereitstellungaus.

Verlässt ein/-e Workspace-Besitzer/-in den Workspace oder wechselt die Rolle, wird deren Token widerrufen. Die verbleibenden Workspace-Besitzer/-innen erhalten eine automatische Aufforderung, den widerrufenen Token zu ersetzen.

Aktive Token können auch von allen Workspace-Besitzer/-innen im Workspace widerrufen werden. Klicke dazu neben dem jeweiligen Token auf 🗑.

Wird ein Token zurückgezogen, muss dieser in allen vorhandenen Integrationen ersetzt werden.

SCIM-Integration und Bereitstellungen, die den widerrufenen Token nutzen, werden deaktiviert, bis der Token ersetzt wird.

Um zu steuern, ob Nutzer/-innen Einladungen zu Workspaces und Gruppen per E-Mail erhalten, wenn diese von SCIM bereitgestellt werden, können Organisationsbesitzer/-innen mit Enterprise Plan:

1. Öffne den Workspace Switcher und wähle Organisation verwalten aus.

2. Aktiviere im Tab Allgemein die Option Einladungs-E-Mails von SCIM-Bereitstellung unterdrücken, wenn du keine E-Mails an Nutzer/-innen senden möchtest.

Um ein eingeschränktes Mitglied über SCIM bereitzustellen, musst du das SCIM-Attribut „role“ auf „restricted_member“ setzen:

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

Um einen Seitengast über SCIM zu einem Mitglied mit eingeschränkten Zugriffsrechten zu machen, musst du POST /scim/v2/Users verwenden.

• GET /ServiceProviderConfig

  • GET

  • Ruft eine Beschreibung der verfügbaren SCIM-Funktionen ab

  • Die Definitionen finden sich in Abschnitt 5 der SCIM-Protokollspezifikation.

• GET /ResourceTypes

  • GET

  • Ruft eine Liste der verfügbaren SCIM-Ressourcen ab

  • Die Definitionen finden sich in Abschnitt 6 der SCIM-Protokollspezifikation.

In der Tabelle wird die Zuordnung von SCIM-Benutzerattributen zu Benutzerprofilfeldern in Notion dargestellt. Organisationsbesitzer/-innen wählen aus, welche Attribute an Notion gesendet werden sollen, und können diese Attribute jederzeit aktualisieren. Notion verarbeitet die Attribute, die du über die Notion-SCIM-API sendest, um die Bereitstellung und Verwaltung von Nutzer/-innen und Gruppen zu verbessern.

• GET /Users

  • GET

  • Ruft eine paginierte Liste der Workspace-Mitglieder ab

  • Nutze die Parameter startIndex und count zum Nummerieren. Beachte, dass startIndex 1-indiziert ist und count einen Höchstwert von 100 hat.

  • Die Ergebnisse können mit dem Parameter Filter gefiltert werden. Gültige Filterattribute sind email, given_name und family_name, z.B.: GET

  • Bei given_name und family_name sollte man auf die korrekte Groß- und Kleinschreibung achten. E-Mail-Adressen werden in Kleinbuchstaben konvertiert.

• GET /Users/

  • GET

  • Findet Workspace-Mitglieder anhand ihrer Mitglieder-ID. Dabei handelt es sich um einen Universally Unique Identifier (UUID) mit 32 Zeichen im Format 00000000-0000-0000-0000-000000000000.

  • Achtung: meta.created und meta.lastModified geben keine aussagekräftigen Zeitstempelwerte wieder.

• POST /Users

  • POST

  • Besitzt ein neu hinzugefügter Person bereits ein Notion-Konto mit derselben E-Mail-Adresse, wird sie deinem Workspace hinzugefügt.

  • Wenn der Benutzer noch nicht vorhanden ist, wird so ein neuer Notion-Benutzer erstellt und in deinen Workspace aufgenommen. Personen werden dem neu erstellen Nutzerprofil hinzugefügt.

  • Die SCIM-API liest die Eigenschaft des Profilfotos bei der Benutzererstellung, jedoch nicht bei zukünftigen Aktualisierungen.

• PATCH /Users/

  • PATCH

  • Mehrstufige Aktualisierung und anschließende Erstellung des geänderten Benutzerdatensatzes

• PUT /Users/

  • PUT

  • Update und Ausgabe des geänderten Benutzerdatensatzes.

• DELETE /Users/

  • DELETE

  • Entfernt Benutzer/-innen aus dem Workspace. Die betroffene Person wird dabei von allen laufenden Sitzungen abgemeldet.

    • Das Benutzerkonto kann nicht über SCIM gelöscht werden. Konten müssen immer manuell gelöscht werden.

    • Nutzer/-innen können auch aus deinem Workspace entfernt werden, indem du das aktive Benutzerattribut auf false setzt. Sende hierzu eine PATCH /Users/ oder eine PUT /Users/-Anfrage.

    • Der Besitzer oder die Besitzerin des Workspaces, der oder die das SCIM-Bot-Token erstellt hat, kann nicht über die API entfernt werden. Geschieht dies dennoch, werden alle von ihm oder ihr erstellten Token widerrufen und alle Einbindungen, die den jeweiligen Bot verwenden, werden unterbrochen.

• GET /Groups

  • GET

  • Ruft eine paginierte Liste der Workspace-Gruppen ab

  • Nutze die Parameter startIndex und count zum Nummerieren. Beachte, dass startIndex 1-indiziert ist und count einen Höchstwert von 100 hat, z. B. GET

    • Wenn die Nummerierung nicht verwendet wird, werden in einer Anfrage maximal 100 Workspace-Gruppen herausgegeben.

  • Die Ergebnisse können mit dem Parameter Filter gefiltert werden. Gruppen können anhand des Attributs displayName gefiltert werden, z. B. GET

• GET /Groups/

  • GET

  • Findet Workspace-Mitglieder anhand ihrer Gruppen-ID. Dabei handelt es sich um einen Universally Unique Identifier (UUID) mit 32 Zeichen im Format 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • Erstellt eine neue Workspace-Gruppe

• PATCH /Groups/

  • PATCH

  • Mehrstufige Aktualisierung der Workspace-Gruppe

• PUT /Groups/

  • PUT

  • Aktualisiert die Workspace-Gruppe

• DELETE /Groups/

  • DELETE

  • Löscht die Workspace-Gruppe