Provisioi käyttäjät ja ryhmät SCIMin avulla
Voit provisioida ja hallita käyttäjiä ja ryhmiä Notion-työtilassasi System for Cross-domain Identity Management (SCIM) -API-standardin avulla 🔑
Huomio: Tämä ominaisuus on käytettävissä vain Enterprise-sopimuksen käyttäjille.
Notionin SCIM API mahdollistaa seuraavat toiminnot:
Käyttäjien provisiointi ja hallinta
Luo ja poista jäseniä työtilastasi.
Päivitä jäsenen profiilitiedot.
Hae työtilasi jäsenet.
Etsi jäseniä sähköpostiosoitteen tai nimen perusteella.
Ryhmien provisiointi ja hallinta
Luo ja poista ryhmiä työtilastasi.
Lisää ja poista ryhmän jäseniä.
Hae työtilasi ryhmät.
Etsi ryhmiä nimen perusteella.
Huomio: Tällä hetkellä et voi hallita työtilan vieraita Notionin SCIM-rajapinnan kautta.
Tuemme tällä hetkellä Oktaa, OneLoginia, Ripplingiä ja mukautettuja SCIM-sovelluksia. Jos käytät muuta identiteetinhallintapalvelua, kerro siitä meille. Katso ohjeet identiteetinhallintapalvelun määrittämiseen tietyille sovelluksille täältä →
SCIMin käytön edellytykset Notionissa
SCIMin käyttäminen Notionissa edellyttää:
Työtilallasi on oltava Enterprise-sopimus.
Identiteetinhallintapalvelusi (IdP) tulee tukea SAML 2.0 -protokollaa. Katso ohjeet identiteetinhallintapalvelun määrittämiseen tietyille sovelluksille täältä →
Työtilasi omistajan täytyy määrittää SCIM Notion-työtilassa.
Sinun on vahvistettava sähköpostiverkkotunnuksen omistajuus, jos haluat käyttää SCIM-palvelua käyttäjän nimen tai sähköpostiosoitteen muokkaamiseen. Lue lisää verkkotunnuksen vahvistamisesta →
Luo SCIM API -tunnus
Vain Enterprise-sopimuksen organisaation omistajat voivat luoda ja tarkastella SCIM API -tunnuksia. SCIM API -tunnuksen luominen:
Avaa työtilan vaihtaja ja valitse
Hallitse organisaatiota. Sinun on ehkä ensinMääritä organisaatio, jos et ole vielä tehnyt niin. Lue lisää täältä →Valitse organisaatiotason hallintatyökalujen
Yleiset-välilehdellä>kohdanSCIM-provisiointivierestä.
Huomio: Jokaiselle työtilalle, jota haluat hallita SCIM:n kautta, on luotava erillinen SCIM-rajapintatunniste.
Peruuta tunnukset
Kun työtilan omistaja poistuu työtilasta tai hänen roolinsa muuttuu, hänen tunnuksensa peruutetaan. Kun näin tapahtuu, jäljellä oleville työtilan omistajille lähetetään automaattinen viesti, jossa heitä pyydetään korvaamaan peruutettu tunnus.
Lisäksi työtilan omistajat voivat peruuttaa aktiivisia tunnuksia työtilassa. Peruuta tunnus napsauttamalla 🗑-kuvaketta kyseisen tunnuksen kohdalla.
Korvaa olemassa olevat tunnukset
Jos tunnus peruutetaan, se on korvattava kaikissa olemassa olevissa integraatioissa.
Kaikki SCIM-integraatiot ja käyttäjien provisiointi, jotka perustuvat kumottuun tunnukseen, poistetaan käytöstä, kunnes ne korvataan aktiivisella tunnuksella.
Huomio: Jotta olemassa olevat integraatiot eivät rikkoutuisi, muista korvata kaikki ylläpitäjään liittyvät tunnisteet ennen niiden käyttöoikeuksien poistamista.
Estä kutsusähköpostit
Enterprise-sopimuksen organisaation omistajat voivat hallita, saavatko käyttäjät kutsut työtiloihin ja ryhmiin sähköpostitse, kun heidät provisioidaan SCIMin avulla, seuraavasti:
Avaa työtilan valitsin ja valitse
Hallitse organisaatiota.Yleiset-välilehdellä ota käyttöönEstä SCIM-provisioinnin kutsusähköpostit, jos et halua lähettää sähköposteja käyttäjille.
Ota rajoitetut jäsenet käyttöön SCIMin avulla.
Jos haluat ottaa käyttöön rajoitetun jäsenen SCIMin avulla, sinun on asetettava SCIMin 'role'-attribuuttiksi 'restricted_member':
\"urn:ietf:params:scim:schemas:extension:notion:2.0:User\": { role: string // \"owner\" | \"membership_admin\" | \"member\" | \"restricted_member\" }
Jos haluat muuntaa sivuvieraan rajoitetuksi jäseneksi SCIM:n kautta, sinun on käytettävä POST /scim/v2/Users.
GET /ServiceProviderConfigGETNouda kuvaus käytettävissä olevista SCIM-määritysominaisuuksista.
Määritetty SCIM-protokollamäärityksen kohdassa 5.
GET /ResourceTypesGETHae luettelo käytettävissä olevista SCIM-resurssityypeistä.
Määritetty SCIM-protokollamäärityksen kohdassa 6.
Alla olevassa taulukossa esitetään SCIM-käyttäjäattribuuttien ja Notion-käyttäjäprofiilikenttien välinen vastaavuus. Organisaation omistajat valitsevat, mitä attribuutteja Notionille lähetetään, ja voivat päivittää niitä milloin tahansa. Notion käsittelee Notion SCIM API:n kautta lähettämiäsi attribuutteja parantaakseen käyttäjien ja ryhmien hallintaa ja provisiointia.
SCIM-attribuutti | Notion-käyttäjäprofiilikenttä | Ulkoinen nimiavaruus |
|---|---|---|
userName | Sähköposti (Tämä kenttä on pakollinen) |
|
name.formatted | Nimi (Suositeltu nimikenttä. Koska Notionissa on vain yksi nimikenttä, voit luoda Oktassa lausekkeen, jolla yhdistät nimikentät.) |
|
name.familyName | Nimi (Voidaan käyttää yhdessä name.givenName-kentän kanssa vaihtoehtona name.formatted-kentälle.) |
|
name.givenName | Nimi (Voidaan käyttää yhdessä name.familyName-kentän kanssa vaihtoehtona name.formatted-kentälle.) |
|
kuvat | Profiilikuva |
|
nimike | Otsikko |
|
puhelinnumerot | Puhelinnumero |
|
osoitteet | Osoite |
|
roolit | Rooli |
|
Alueasetus | Kieli |
|
ensisijainen kieli | Ensisijainen kieli |
|
käyttäjätyyppi | Käyttäjätyyppi |
|
sähköpostiosoitteet | Sähköposti |
|
Aktiivinen | Aktiivinen |
|
manager.value | Esihenkilö (tämän tulee olla sähköpostiosoite) |
|
manager.displayName | Esihenkilö |
|
osasto | Osasto |
|
osasto | Osasto |
|
costCenter | Kustannuspaikka |
|
organisaatio | Organisaatio |
|
employeeNumber | Employee Number |
|
rooli | Notion-työtilan rooli ("Omistaja" | "Jäsenyyden ylläpitäjä" | "jäsen") |
|
Huomio: Notion tallentaa vain ensimmäisen phoneNumbers-merkinnän, jossa primary=true. Kaikki muut merkinnät hylätään. type-kenttä jätetään kokonaan huomiotta. Huomaa, että primary ei kuulu SCIM 2.0 -määritykseen – Notion käsittelee sitä eri tavalla kuin standardia. Jos millään merkinnällä ei ole primary=true, puhelinnumeroa ei tallenneta.
GET /UsersGETHae sivutettu luettelo työtilan jäsenistä.
Voit sivuttaa käyttämällä
startIndex- jacount-parametreja. Huomaa, ettästartIndexon 1-indeksoitu ja count-parametrin enimmäisarvo on 100.Voit suodattaa tuloksia
filter-parametrilla. Kelvollisia suodatusmääritteitä ovatemail,given_namejafamily_name, esim.GETHuomaa, että
given_namejafamily_nameovat kirjainkoosta riippuvaisia. Sähköpostiosoite muutetaan pieniksi kirjaimiksi.
GET /Users/GETHae tietty työtilan jäsen Notion-käyttäjätunnuksella. Tämä on 32-merkkinen UUID seuraavassa muodossa:
00000000-0000-0000-0000-000000000000.Huomaa, että
meta.createdjameta.lastModifiedeivät vastaa merkityksellisiä aikaleima-arvoja.
POST /UsersPOSTJos lisäämälläsi käyttäjällä on jo Notion-käyttäjätili samalla sähköpostiosoitteella, hänet lisätään työtilaasi.
Jos käyttäjää ei ole olemassa, tämän kutsuminen luo uuden Notion-käyttäjän ja lisää kyseisen käyttäjän työtilaan. Hänet yhdistetään luotavaan Notion-käyttäjäprofiiliin.
SCIM-rajapinta lukee profiilikuvaominaisuuden käyttäjän luonnin yhteydessä, mutta ei päivitysten yhteydessä.
PATCH /Users/PATCHPäivitä sarjalla operaatioita ja palauta päivitetty käyttäjätietue.
Huomio: Voit päivittää jäsenen profiilitietoja vain, jos olet vahvistanut käyttäjän sähköpostidomainin omistajuuden (tämä on yleensä sama kuin sähköpostidomainit, jotka olet määrittänyt Notionin SAML Single Sign-On -kirjautumista varten). Vahvista domainisi ohjeiden täällä avulla →
PUT /Users/PUTPäivitä ja palauta päivitetty käyttäjätietue.
DELETE /Users/DELETEPoista käyttäjä työtilastasi. Käyttäjä kirjataan ulos kaikista aktiivisista istunnoista.
Käyttäjätiliä ei voi poistaa SCIMin kautta. Tilin poistaminen on tehtävä manuaalisesti.
Käyttäjän poistaminen työtilasta voidaan saavuttaa myös asettamalla
active-käyttäjämäärite arvoonfalselähettämälläPATCH /Users/- taiPUT /Users/-pyyntö.SCIM-bottitunnisteen luonutta työtilan omistajaa ei voi poistaa API:n kautta. Kun työtilan omistaja poistetaan SCIM API:n kautta, kaikki hänen luomansa tunnisteet mitätöidään ja kaikki kyseistä bottia käyttävät integraatiot lakkaavat toimimasta.
Huomio: Voit määrittää työtilan tasoja käyttäjille käyttämällä role-attribuuttia, joka on laajennus olemassa olevaan käyttäjäskeemaan. Muoto on:
\"urn:ietf:params:scim:schemas:extension:notion:2.0:User\": { role: merkkijono // \"owner\" | \"membership_admin\" | \"member\" }
GET /GroupsGETHae sivutettu luettelo työtilaryhmistä.
Voit sivuttaa tulokset käyttämällä
startIndex- jacount-parametreja. Huomaa, ettästartIndexon 1-indeksoitu ja count-parametrin enimmäisarvo on 100, esim.GETJos sivutusta ei käytetä, pyynnössä palautetaan enintään 100 työtilaryhmää.
Voit suodattaa tuloksia
filter-parametrilla. Ryhmiä voi suodattaa niidendisplayName-määritteen perusteella, esim.GET
GET /Groups/GETHae tietty työtilaryhmä Notion-ryhmätunnuksen perusteella. Tämä on 32-merkkinen UUID seuraavassa muodossa:
00000000-0000-0000-0000-000000000000.
POST /GroupsPOSTLuo uusi työtilaryhmä.
PATCH /Groups/PATCHPäivitä työtilaryhmää sarjan operaatioiden avulla.
PUT /Groups/PUTPäivitä työtilaryhmä.
DELETE /Groups/DELETEPoista työtilaryhmä.
Huomio: Ryhmän poistaminen on kiellettyä, jos se johtaisi siihen, ettei kenelläkään ole täydet käyttöoikeudet yhdelle tai useammalle sivulle.
