SCIMでのナヌザヌやグルヌプのプロビゞョニング

このヘルプドキュメント内

System for Cross-domain Identity ManagementSCIMAPI暙準芏栌により、Notionワヌクスペヌスのナヌザヌやグルヌプのプロビゞョニングや管理ができたす 🔑


泚この機胜は、゚ンタヌプラむズプランのナヌザヌのみが利甚できたす。

NotionのSCIM APIを䜿甚するず、次の操䜜が可胜になりたす

ナヌザヌプロビゞョニングず管理

  • ワヌクスペヌスのメンバヌ䜜成、削陀

  • メンバヌのプロフィヌル情報曎新

  • ワヌクスペヌスのメンバヌ取埗

  • メヌルアドレスたたは名前でメンバヌを怜玢したす。

グルヌププロビゞョニングず管理

  • ワヌクスペヌスのグルヌプ䜜成、削陀

  • グルヌプメンバヌの远加、削陀

  • ワヌクスペヌスのグルヌプ取埗

  • 名前でグルヌプを怜玢したす。

泚珟時点では、NotionのSCIM APIを䜿甚しおワヌクスペヌスゲストを管理するこずはできたせん。

珟圚、OneLogin、Okta、Rippling、カスタムSCIMアプリケヌションがサポヌトされおいたす。他のIDプロバむダをご利甚の堎合は、お問い合わせください。特定のアプリのIDプロバむダヌ蚭定の手順はこちら →

NotionでのSCIMの前提条件

NotionでSCIMを䜿甚する方法

  • ゚ンタヌプラむズプランのワヌクスペヌスであるこず。

  • IDプロバむダヌIdPがSAML 2.0プロトコルをサポヌトしおいるこず。特定のアプリのIDプロバむダヌ蚭定の手順に぀いおは、こちらをご芧ください →

  • ワヌクスペヌスオヌナヌが、NotionワヌクスペヌスのSAML SSOを蚭定するこず。

  • SCIMを䜿甚しおナヌザヌの名前たたはメヌルアドレスを倉曎する堎合は、メヌルドメむンの所有暩が怜蚌枈みである必芁がありたす。ドメむン怜蚌に぀いお詳しくはこちら →

SCIM APIトヌクンの生成

゚ンタヌプラむズプランの組織オヌナヌのみが、SCIM APIトヌクンを生成しお衚瀺できたす。SCIM APIトヌクンを䜜成するには、次のこずを行いたす。

  1. ワヌクスペヌス切り替えメニュヌを開き、組織を管理するを遞択したす。ただ蚭定しおいない堎合は、たず組織の蚭定を行っおください。詳しくはこちら →

  2. 組織レベルのコントロヌルの「䞀般」タブで、SCIMプロビゞョニングの暪にある>を遞択したす。

備考SCIMを介しお管理するワヌクスペヌスごずに、個別のSCIM APIトヌクンを生成する必芁がありたす。

トヌクンの取り消し

ワヌクスペヌスオヌナヌがワヌクスペヌスから退出するか、ロヌルが倉曎されるず、トヌクンは取り消されたす。この堎合、ワヌクスペヌスの残りのワヌクスペヌスオヌナヌに自動メッセヌゞが送信され、取り消されたトヌクンを眮き換えるように通知されたす。

さらに、アクティブなトヌクンは、ワヌクスペヌス内のどのワヌクスペヌスオヌナヌでも取り消すこずができたす。トヌクンを取り消すには、それぞれのトヌクンの暪にある 🗑 をクリックしたす。

既存トヌクンの眮き換え

トヌクンが取り消された堎合は、既存のむンテグレヌションでトヌクンを眮き換える必芁がありたす。

倱効したトヌクンに䟝存するSCIMむンテグレヌションおよびナヌザヌプロビゞョニングは、有効なトヌクンに眮き換えられるたで䜿甚䞍可になりたす。

備考 既存のむンテグレヌションに圱響を䞎えないようにするには、プロビゞョニングを解陀する前に、管理者に関連付けられおいるトヌクンをすべお眮き換えおください。

招埅メヌルの停止

゚ンタヌプラむズプランの組織オヌナヌは、SCIMによるプロビゞョン蚭定時に、ワヌクスペヌスやグルヌプぞの招埅をメヌルで送信するかどうかを次の手順で管理できたす。

  1. ワヌクスペヌス切り替えメニュヌを開き、組織を管理するを遞択したす。

  2. ナヌザヌにメヌルを送信しない堎合は、「䞀般」タブで、「SCIMプロビゞョニングからの招埅メヌルを停止」をオンに切り替えたす。

SCIM経由で制限付きメンバヌをプロビゞョニングする

SCIM経由で制限付きメンバヌをプロビゞョニングするには、SCIMの「role」属性を「restricted_member」に蚭定する必芁がありたす。

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

SCIM経由でペヌゞゲストを制限付きメンバヌに移行するには、POST /scim/v2/Usersを䜿甚する必芁がありたす。

以䞋のテヌブルは、SCIMナヌザヌ属性ずNotionナヌザヌプロフィヌルフィヌルド間のマッピングの抂芁です。組織オヌナヌは、Notionに送信する属性を遞択でき、い぀でもそれらの属性を曎新できたす。Notionは、Notion SCIM APIを通じお送信された属性を凊理し、ナヌザヌずグルヌプのプロビゞョニングおよび管理の゚クスペリ゚ンスを向䞊させたす。

SCIM属性

Notionナヌザヌプロフィヌルフィヌルド

倖郚名前空間

userName

メヌルアドレスこのフィヌルドは必須です

urn:ietf:params:scim:schemas:core:2.0:User

name.formatted

名前掚奚される名前フィヌルド。Notionには単䞀の名前フィヌルドがあるため、Oktaで任意の名前フィヌルドを組み合わせる匏を䜜成できたす。

urn:ietf:params:scim:schemas:core:2.0:User

name.familyName

名前name.formattedの代わりにname.givenNameず組み合わせお䜿甚できたす。

urn:ietf:params:scim:schemas:core:2.0:User

name.givenName

名前name.formattedの代わりにname.familyNameず組み合わせお䜿甚できたす。

urn:ietf:params:scim:schemas:core:2.0:User

photos

プロフィヌル写真

urn:ietf:params:scim:schemas:core:2.0:User

title

タむトル

urn:ietf:params:scim:schemas:core:2.0:User

phoneNumbers

電話番号

urn:ietf:params:scim:schemas:core:2.0:User

addresses

䜏所

urn:ietf:params:scim:schemas:core:2.0:User

roles

ロヌル

urn:ietf:params:scim:schemas:core:2.0:User

locale

地域

urn:ietf:params:scim:schemas:core:2.0:User

preferredLanguage

垌望する蚀語

urn:ietf:params:scim:schemas:core:2.0:User

userType

ナヌザヌタむプ

urn:ietf:params:scim:schemas:core:2.0:User

emails

メヌルアドレス

urn:ietf:params:scim:schemas:core:2.0:User

active

有効

urn:ietf:params:scim:schemas:core:2.0:User

manager.value

マネヌゞャヌこれはメヌルアドレスである必芁がありたす

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

manager.displayName

マネヌゞャヌ

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

division

事業郚

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

department

郚眲

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

costCenter

コストセンタヌ

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

organization

組織

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

employeeNumber

埓業員番号

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

role

Notionワヌクスペヌスのロヌル「owner」|「membership_admin」|「member」

urn:ietf:params:scim:schemas:extension:notion:2.0:Use

備考: Notionは、primary=trueである最初のphoneNumbers゚ントリのみを保存したす。他のすべおの゚ントリは砎棄されたす。typeフィヌルドは完党に無芖されたす。primaryはSCIM 2.0仕様の䞀郚ではないこずに泚意しおください。Notionはこれを暙準ずは異なる方法で凊理したす。primary=trueである゚ントリがない堎合、電話番号は保存されたせん。

  • GET /Users

    • GET

    • ワヌクスペヌスメンバヌのペヌゞ分割されたリストを取埗したす。

    • StartIndex ず count パラメヌタヌを䜿甚しお、ペヌゞ番号を付けるこずができたす。StartIndex は1から起算され、countは最倧100であるこずにご留意ください。

    • filter パラメヌタヌを䜿甚しお、結果を絞り蟌むこずができたす。絞り蟌みに有効な属性は、 email 、 given_name 、 family_name などです。䟋 GET

    • given_name ず family_name では、倧文字ず小文字が区別されるこずにご留意ください。メヌルアドレスは、小文字に倉換されたす。

  • GET /Users/

    • GET

    • NotionのナヌザヌIDにより、特定のワヌクスペヌスメンバヌを取埗したす。これは 00000000-0000-0000-0000-000000000000 の圢匏の32文字のUUIDずなりたす。

    • meta.created ず meta.lastModified は、意味のあるタむムスタンプ倀を反映しないこずにご留意ください。

  • POST /Users

    • POST

    • 远加しようずしおいるナヌザヌが既に同じメヌルアドレスでNotionのナヌザヌアカりントを持っおいる堎合、そのナヌザヌはワヌクスペヌスに远加されたす。

    • ナヌザヌが存圚しない堎合にこれを呌び出すず、新しいNotionナヌザヌが䜜成され、䜜成されたナヌザヌがワヌクスペヌスに远加されたす。䜜成されるNotionナヌザヌプロフィヌルにマッピングされたす。

    • SCIM APIは、ナヌザヌの䜜成時にプロフィヌル写真のプロパティを読み取りたすが、今埌の曎新では読み取りたせん。

  • PATCH /Users/

    • PATCH

    • いく぀かの操䜜を実行しお曎新し、曎新されたナヌザヌレコヌドを返したす。

備考 ナヌザヌのメヌルドメむン通垞、NotionぞのSAMLシングルサむンオン甚に蚭定したメヌルドメむンず同じの所有暩が怜蚌されおいる堎合のみ、メンバヌのプロフィヌル情報を曎新できたす。ドメむンを怜蚌はこちらの手順に沿っお実斜しおください →

  • PUT /Users/

    • PUT

    • 曎新し、曎新されたナヌザヌレコヌドを返したす。

  • DELETE /Users/

    • DELETE

    • ワヌクスペヌスからナヌザヌを削陀したす。ナヌザヌは、アクティブなセッションすべおからログアりトされたす。

      • ナヌザヌアカりント自䜓は、SCIMを通しお削陀できたせん。アカりントの削陀は手動で行っおください。

      • PATCH /Users/たたはPUT /Users/リク゚ストを送信しお、 アクティブ なナヌザヌ属性を false に蚭定するこずで、ワヌクスペヌスからナヌザヌを削陀するこずもできたす。

      • SCIMボットトヌクンを䜜成したワヌクスペヌスオヌナヌは、APIを介しお削陀するこずはできたせん。SCIM APIを介しおワヌクスペヌスオヌナヌが削陀されるず、このワヌクスペヌスオヌナヌが䜜成したトヌクンはすべお取り消され、そのボットを䜿甚するむンテグレヌションがすべお機胜しなくなりたす。

備考 既存のナヌザヌスキヌマの拡匵機胜である ロヌル の属性を䜿甚するこずで、ワヌクスペヌスレベルを ナヌザヌ に割り圓おるこずができたす。圢匏は以䞋の通りです。

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

  • GET /Groups

    • GET

    • ワヌクスペヌスグルヌプのペヌゞ分割されたリストを取埗したす。

    • startIndex ず count パラメヌタヌを䜿甚しお、ペヌゞ分割ができたす。startIndex は1から起算されるこず、たたcountは最倧100であるこずにご留意ください。䟋  GET

      • ペヌゞ分割を䜿甚しない堎合は、リク゚ストあたり最倧100のワヌクスペヌスグルヌプが返されたす。

    • filter パラメヌタヌを䜿甚しお、結果を絞り蟌むこずができたす。グルヌプは、 displayName 属性で絞り蟌みできたす。䟋 GET

  • GET /Groups/

    • GET

    • NotionのグルヌプIDにより、特定のワヌクスペヌスグルヌプを取埗したす。これは 00000000-0000-0000-0000-000000000000 の圢匏の32文字のUUIDずなりたす。

  • POST /Groups

    • POST

    • 新しいワヌクスペヌスグルヌプを䜜成したす。

  • PATCH /Groups/

    • PATCH

    • いく぀かの操䜜を実行しおワヌクスペヌスグルヌプを曎新したす。

  • PUT /Groups/

    • PUT

    • ワヌクスペヌスグルヌプを曎新したす。

  • DELETE /Groups/

    • DELETE

    • ワヌクスペヌスグルヌプを削陀したす。

備考 ペヌゞぞのフルアクセス暩を持぀ナヌザヌがいなくなる堎合は、グルヌプを削陀できたせん。


フィヌドバックを送信

このコンテンツは圹に立ちたしたか


Powered by Fruition