Esegui il provisioning di utenti e gruppi con SCIM
Puoi eseguire il provisioning e gestire utenti e gruppi nel tuo spazio di lavoro Notion con lo standard API System for Cross-domain Identity Management (SCIM) 🔑
Nota: Questa funzionalità è disponibile solo per gli utenti del piano Enterprise.
L'API SCIM di Notion ti consente di fare quanto segue:
Provisioning e gestione degli utenti
Crea e rimuovi membri nel tuo spazio di lavoro.
Aggiorna le informazioni del profilo di un membro.
Recupera i membri nel tuo spazio di lavoro.
Trova membri per email o nome.
Provisioning e gestione dei gruppi
Crea e rimuovi gruppi nel tuo spazio di lavoro.
Aggiungi e rimuovi membri in un gruppo.
Recupera i gruppi nel tuo spazio di lavoro.
Trova gruppi per nome.
Nota: Al momento, non è possibile gestire gli ospiti dello spazio di lavoro utilizzando l'API SCIM di Notion.
Attualmente supportiamo Okta, OneLogin, Rippling e applicazioni SCIM personalizzate. Se utilizzi un altro Identity Provider, faccelo sapere. Consulta le istruzioni per la configurazione dell'Identity Provider per app specifiche qui →
Prerequisiti per SCIM con Notion
Per utilizzare SCIM con Notion:
Il tuo spazio di lavoro deve disporre di un piano Enterprise.
Il tuo Identity Provider (IdP) deve supportare il protocollo SAML 2.0. Consulta le istruzioni per la configurazione dell'Identity Provider per app specifiche qui →
Un proprietario del workspace deve configurare SCIM per il workspace Notion.
Devi aver verificato la proprietà di un dominio email se desideri utilizzare SCIM per modificare il nome o l'indirizzo email di un utente. Scopri di più sulla verifica del dominio →
Genera il tuo token API SCIM
Solo i proprietari dell'organizzazione del piano Enterprise possono generare e visualizzare i token API SCIM. Per creare un token API SCIM:
Apri il selettore dello spazio di lavoro e seleziona
Gestisci organizzazione. Potrebbe essere necessarioConfigurare l'organizzazioneprima, se non l'hai già fatto. Scopri di più qui →Nella scheda
Generaledei controlli a livello di organizzazione, seleziona>accanto aProvisioning SCIM.
Nota: Per ogni spazio di lavoro che desideri gestire tramite SCIM, devi generare un token API SCIM separato.
Revoca token
Quando un proprietario dello spazio di lavoro lascia lo spazio di lavoro o il suo ruolo viene modificato, il suo token verrà revocato. Quando ciò accade, verrà inviato un messaggio automatico ai restanti proprietari dello spazio di lavoro per notificare loro di sostituire il token revocato.
Inoltre, i token attivi possono essere revocati da qualsiasi proprietario dello spazio di lavoro. Per revocare un token, clicca su 🗑 accanto al token corrispondente.
Sostituisci i token esistenti
Se un token viene revocato, dovrai sostituirlo in tutte le integrazioni esistenti.
Qualsiasi integrazione SCIM e provisioning degli utenti che si basano sul token revocato verranno disabilitati finché non verranno sostituiti da un token attivo.
Nota: Per evitare interruzioni nelle integrazioni esistenti, assicurati di sostituire tutti i token associati a un amministratore prima di procedere al deprovisioning.
Sopprimi email di invito
Per controllare se gli utenti riceveranno inviti a spazi di lavoro e gruppi via email quando sottoposti a provisioning tramite SCIM, i proprietari dell'organizzazione del piano Enterprise possono:
Apri il selettore dello spazio di lavoro e seleziona
Gestisci organizzazione.Nella scheda
Generale, attivaSopprimi email di invito dal provisioning SCIMse non desideri inviare email agli utenti.
Effettua il provisioning di membri con accesso limitato tramite SCIM
Per effettuare il provisioning di un membro con accesso limitato tramite SCIM, devi impostare l'attributo 'role' di SCIM su 'restricted_member':
\"urn:ietf:params:scim:schemas:extension:notion:2.0:User\": { role: string // \"owner\" | \"membership_admin\" | \"member\" | \"restricted_member\" }
Per trasformare un ospite della pagina in un membro con accesso limitato tramite SCIM, devi utilizzare POST /scim/v2/Users.
GET /ServiceProviderConfigGETRecupera una descrizione delle funzionalità disponibili della specifica SCIM.
Definito nella Sezione 5 della specifica del protocollo SCIM.
GET /ResourceTypesGETRecupera un elenco dei tipi di risorsa SCIM disponibili.
Definito nella Sezione 6 della specifica del protocollo SCIM.
La tabella seguente delinea la mappatura tra gli attributi utente SCIM e i campi del profilo utente Notion. I proprietari dell'organizzazione scelgono quali attributi inviare a Notion e possono aggiornare tali attributi in qualsiasi momento. Notion elabora gli attributi inviati tramite l'API SCIM di Notion per migliorare l'esperienza di provisioning e gestione di utenti e gruppi.
Attributo SCIM | Campo del profilo utente Notion | Spazio dei nomi esterno |
|---|---|---|
userName | Email (Questo campo è obbligatorio) |
|
name.formatted | Nome (Il campo nome consigliato. Poiché Notion ha un unico campo nome, puoi creare un'espressione in Okta per combinare qualsiasi campo nome.) |
|
name.familyName | Nome (Può essere utilizzato in combinazione con name.givenName come alternativa a name.formatted.) |
|
name.givenName | Nome (Può essere utilizzato in combinazione con name.familyName come alternativa a name.formatted.) |
|
photos | Foto del profilo |
|
Titolo | Titolo |
|
numeri di telefono | Numero di telefono |
|
indirizzi | Indirizzo |
|
ruoli | Ruolo |
|
locale | Lingua |
|
lingua preferita | Lingua preferita |
|
tipo utente | Tipo di utente |
|
| ||
attivo | Attivo |
|
manager.value | Manager (deve essere un indirizzo email) |
|
manager.displayName | Responsabile |
|
divisione | Divisione |
|
dipartimento | Reparto |
|
costCenter | Centro di costo |
|
organizzazione | Organizzazione |
|
employeeNumber | Numero dipendente |
|
ruolo | Ruolo dello spazio di lavoro Notion ("owner" | "membership_admin" | "member") |
|
Nota: Notion archivia solo la prima voce phoneNumbers in cui primary=true. Tutte le altre voci vengono eliminate. Il campo type viene ignorato completamente. Nota che primary non fa parte delle specifiche SCIM 2.0: Notion lo gestisce in modo diverso dallo standard. Se nessuna voce ha primary=true, non verrà archiviato alcun numero di telefono.
GET /UsersGETRecupera un elenco paginato dei membri dello spazio di lavoro.
È possibile effettuare la paginazione utilizzando i parametri
startIndexecount. Nota chestartIndexè numerato a partire da 1 e count ha un massimo di 100.È possibile filtrare i risultati con il parametro
filter. Gli attributi validi per il filtro sonoemail,given_nameefamily_name, ad esempioGETNota che
given_nameefamily_namefanno distinzione tra maiuscole e minuscole. L'email viene convertita in minuscolo.
GET /Users/GETRecupera uno specifico membro dello spazio di lavoro tramite il suo ID utente Notion. Si tratterà di un UUID di 32 caratteri nel seguente formato:
00000000-0000-0000-0000-000000000000.Si noti che
meta.createdemeta.lastModifiednon riflettono valori di timestamp significativi.
POST /UsersPOSTSe l'utente che stai aggiungendo possiede già un account utente Notion con la stessa email, verrà aggiunto al tuo spazio di lavoro.
Se l'utente non esiste, questa chiamata creerà un nuovo utente Notion e lo aggiungerà al tuo spazio di lavoro. Verrà associato al profilo utente Notion creato.
L'API SCIM leggerà la proprietà della foto del profilo alla creazione dell'utente, ma non negli aggiornamenti futuri.
PATCH /Users/PATCHAggiorna tramite una serie di operazioni e restituisce il record utente aggiornato.
Nota: Puoi aggiornare le informazioni del profilo di un membro solo se hai verificato la proprietà del dominio email dell'utente (solitamente corrisponde ai domini email configurati per il Single Sign-On SAML con Notion). Verifica il tuo dominio seguendo le istruzioni qui →
PUT /Users/PUTAggiorna e restituisce il record utente aggiornato.
DELETE /Users/DELETERimuovi un utente dal tuo spazio di lavoro. L'utente viene disconnesso da tutte le sessioni attive.
L'account utente non può essere eliminato tramite SCIM. L'eliminazione dell'account deve essere eseguita manualmente.
La rimozione di un utente dal tuo spazio di lavoro può essere ottenuta anche impostando l'attributo utente
activesufalseinviando una richiestaPATCH /Users/oPUT /Users/.Il proprietario dello spazio di lavoro che ha creato il token del bot SCIM non può essere rimosso tramite l'API. Quando un proprietario dello spazio di lavoro viene rimosso tramite l'API SCIM, tutti i token creati da lui verranno revocati e tutte le integrazioni che utilizzano quel bot smetteranno di funzionare.
Nota: Puoi assegnare i livelli dello spazio di lavoro agli Utenti utilizzando l'attributo role, che è un'estensione dello schema Utente esistente. Il formato è:
\"urn:ietf:params:scim:schemas:extension:notion:2.0:User\": { role: string // \"owner\" | \"membership_admin\" | \"member\" }
GET /GroupsGETRecupera un elenco paginato dei gruppi dello spazio di lavoro.
È possibile effettuare la paginazione utilizzando i parametri
startIndexecount. Nota chestartIndexè indicizzato a partire da 1 e count ha un massimo di 100, ad es.GETSe non viene utilizzata la paginazione, in una richiesta verrà restituito un massimo di 100 gruppi dello spazio di lavoro.
È possibile filtrare i risultati con il parametro
filter. I gruppi possono essere filtrati in base al loro attributodisplayName, ad es.GET
GET /Groups/GETRecupera un gruppo specifico dello spazio di lavoro tramite il suo ID gruppo Notion. Sarà un UUID di 32 caratteri nel seguente formato:
00000000-0000-0000-0000-000000000000.
POST /GroupsPOSTCrea un nuovo gruppo dello spazio di lavoro.
PATCH /Groups/PATCHAggiorna un gruppo dello spazio di lavoro tramite una serie di operazioni.
PUT /Groups/PUTAggiorna un gruppo dello spazio di lavoro.
DELETE /Groups/DELETEElimina un gruppo dello spazio di lavoro.
Nota: L'eliminazione di un gruppo sarà vietata se dovesse comportare l'assenza di un utente con accesso completo a una o più pagine.
Scopri di più
