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

Benutzer/-innen und Gruppen können in Notion mit dem API-Standard „System for Cross-domain Identity Management“ bereitgestellt und verwaltet werden 🔑

Hinweis: Diese Funktion steht nur Nutzer/-innen im Enterprise Plan zur Verfügung.
Die SCIM-API von Notion ermöglicht dir Folgendes:
Bereitstellung und Verwaltung von Nutzer/-innen
Workspace-Mitglieder erstellen und entfernen
Profilinformationen von Mitgliedern ändern
Workspace-Mitglieder abrufen
Mitglieder anhand von E-Mail-Adresse und Namen suchen
Bereitstellung und Verwaltung von Gruppen
Workspace-Gruppen erstellen und entfernen
Gruppenmitglieder hinzufügen und entfernen
Workspace-Gruppe abrufen
Gruppen anhand von Namen suchen

Hinweis: Derzeit können Gäste in deinem Workspace nicht über die SCIM-API von Notion verwaltet werden.
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 →
SCIM bei Notion – Voraussetzungen
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 →
SCIM-API-Token generieren
Nur Organisationsbesitzer/-innen mit Enterprise-Abo können SCIM-API-Token generieren und anzeigen. So erstellst du ein SCIM-API-Token:
Öffne den Workspace Switcher und wähle
Organisation verwalten
aus. Du musst möglicherweise zuerst eineOrganisation einrichten
, falls du dies noch nicht getan hast. Erfahre mehr darüber hier →Wähle im Tab
Allgemein
der Steuerelemente auf Organisationsebene>
nebenSCIM-Bereitstellung
aus.

Note: For each workspace you want to manage via SCIM, you must generate a separate SCIM API token.
Token widerrufen
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 🗑
.
Token ersetzen
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.

Hinweis: Um andere Integrationen nicht zu beeinträchtigen, sollte man vor der Bereitstellungsaufhebung von Admins alle entsprechenden Tokens ersetzen.
Einladungs-E-Mails unterdrücken
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:
Öffne den Workspace Switcher und wähle
Organisation verwalten
aus.Aktiviere im Tab
Allgemein
die OptionEinladungs-E-Mails von SCIM-Bereitstellung unterdrücken
, wenn du keine E-Mails an Nutzer/-innen senden möchtest.
GET /ServiceProviderConfig
GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=serviceproviderconfig>
Ruft eine Beschreibung der verfügbaren SCIM-Funktionen ab
Die Definitionen finden sich in Abschnitt 5 der SCIM-Protokollspezifikation.
GET /ResourceTypes
GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=resourcetypes>
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. Wenn Nutzer/-innen zusätzliche Attributwerte mit Notion teilen, werden diese Attribute gespeichert, um das Notion-Produkterlebnis zu verbessern.
SCIM-Attribut | Notion-Benutzerprofil-Feld |
---|---|
userName | E-Mail (dieses Feld ist ein Pflichtfeld) |
name.formatted | Name (Das empfohlene Namensfeld. Da Notion ein einzelnes Namensfeld hat, kannst du einen Ausdruck in Okta erstellen, um beliebige Namensfelder zu kombinieren.) |
name.familyName | Name (Kann in Kombination mit name.givenName als Alternative zu name.formatted verwendet werden.) |
name.givenName | Name (Kann in Kombination mit name.familyName als Alternative zu name.formatted verwendet werden.) |
Fotos | Profilfoto |
Titel | Titel |
enterprise.manager.value | Manager/-in (Dies sollte eine E-Mail-Adresse sein) |
enterprise.manager.displayName | Manager |
phoneNumbers | Telefonnummer |
addresses | Adresse |
enterprise.division | Geschäftsbereich |
enterprise.department | Abteilung |
enterprise.costCenter | Kostenstelle |
enterprise.organization | Unternehmen |
enterprise.employeeNumber | Mitarbeiter-Nummer |
roles | Rollen |
timezone | Zeitzone |
locale | Gebiet |
preferredLanguage | Bevorzugte Sprache |
userType | Benutzertyp |
emails | |
active | Aktiv |
GET /Users
GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users>
Ruft eine paginierte Liste der Workspace-Mitglieder ab
Nutze die Parameter
startIndex
undcount
zum Nummerieren. Beachte, dassstartIndex
1-indiziert ist und count einen Höchstwert von 100 hat.
Die Ergebnisse können mit dem ParameterFilter
gefiltert werden. Gültige Filterattribute sindemail
,given_name
undfamily_name
, z.B.:GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 users?startindex="1&count=50&filter=email">
eq [email protected]Bei
given_name
undfamily_name
sollte man auf die korrekte Groß- und Kleinschreibung achten. E-Mail-Adressen werden in Kleinbuchstaben konvertiert.
GET /Users/<id>
GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>
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
undmeta.lastModified
geben keine aussagekräftigen Zeitstempelwerte wieder.
POST /Users
POST <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users>
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/<id>
PATCH <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>
Mehrstufige Aktualisierung und anschließende Erstellung des geänderten Benutzerdatensatzes

Hinweis: Du kannst Profildaten von Mitgliedern nur dann ändern, wenn du verifizierte/-r Inhaber/-in der verwendeten E-Mail-Domain des Mitglieds bist. (Diese ist meist mit der E-Mail-Domain identisch, die für SAML-SSO eingerichtet wurde). Verifiziere deine Domain anhand der Anweisungen hier →
PUT /Users/<id>
PUT <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>
Update und Ausgabe des geänderten Benutzerdatensatzes.
DELETE /Users/<id>
DELETE <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>
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 auffalse
setzt. Sende hierzu einePATCH /Users/<id>
oder einePUT /Users/<id>
-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.

Hinweis: Du kannst Benutzer/-innen
mit Hilfe des Rollen
attributs, das eine Erweiterung des vorhandenen Benutzerschemas darstellt, Workspace-Ebenen zuweisen. Das Format lautet wie folgt:
"urn:ietf:params:scim:schemas:extension:notion:2.0:User": { role: string // "owner" | "membership_admin" | "member" }
GET /Groups
GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups>
Ruft eine paginierte Liste der Workspace-Gruppen ab
Nutze die ParameterstartIndex
undcount
zum Nummerieren. Beachte, dassstartIndex
1-indiziert ist und count einen Höchstwert von 100 hat, z. B.GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 groups?startindex="1&count=5">
Wenn die Nummerierung nicht verwendet wird, werden in einer Anfrage maximal 100 Workspace-Gruppen herausgegeben.
Die Ergebnisse können mit dem ParameterFilter
gefiltert werden. Gruppen können anhand des AttributsdisplayName
gefiltert werden, z. B.GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 groups?filter="displayName">
eq Designers
GET /Groups/<id>
GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>
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 <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups>
Erstellt eine neue Workspace-Gruppe
PATCH /Groups/<id>
PATCH <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>
Mehrstufige Aktualisierung der Workspace-Gruppe
PUT /Groups/<id>
PUT <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>
Aktualisiert die Workspace-Gruppe
DELETE /Groups/<id>
DELETE <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>
Löscht die Workspace-Gruppe

Hinweis: Gruppen können nicht gelöscht werden, wenn anschließend niemand mehr vollen Zugriff auf eine oder mehrere Seiten hätte.

Weitere Informationen