使用 SCIM 佈建使用者與群組
您可以使用跨網域身分管理 (SCIM) API 標準,在 Notion 工作空間中佈建與管理使用者及群組 🔑
注意: 此功能僅適用於企業版的使用者。
Notion 的 SCIM API 讓您能夠執行下列操作:
使用者佈建與管理
在您的工作空間中建立與移除成員。
更新成員的個人檔案資訊。
擷取您工作空間中的成員。
依電子郵件或名稱搜尋成員。
群組佈建與管理
在您的工作空間中建立與移除群組。
在群組中新增與移除成員。
擷取您工作空間中的群組。
依名稱搜尋群組。
注意: 目前您無法使用 Notion 的 SCIM API 管理工作空間 訪客。
我們目前支援 Okta、OneLogin、Rippling 以及自訂 SCIM 應用程式。如果您使用其他身分識別提供者,請告訴我們。查看特定應用程式的身分識別提供者設定指示 here →
Notion SCIM 的先決條件
若要將 SCIM 與 Notion 搭配使用:
您的工作空間必須使用企業版方案。
您的身分識別提供者 (IdP) 必須支援 SAML 2.0 通訊協定。查看特定應用程式的身分識別提供者設定說明 請點此 →
工作空間擁有者必須為 Notion 工作空間設定 SCIM。
若您想要使用 SCIM 修改使用者的姓名或電子郵件地址,必須先驗證對電子郵件網域的擁有權。深入了解網域驗證 →
產生您的 SCIM API 權杖
只有企業版 組織擁有者 才能產生並檢視 SCIM API 權杖。若要建立 SCIM API 權杖:
開啟工作空間切換器並選取
管理組織。如果您尚未設定,可能需要先設定組織。在此 瞭解更多 →在您組織層級控制項的
一般分頁中,選取>於SCIM 佈建旁邊。
注意: 對於您想要透過 SCIM 管理的每個工作空間,您必須產生一個獨立的 SCIM API 權杖。
撤銷權杖
當工作空間擁有者離開工作空間或其角色變更時,其權杖將會被撤銷。發生此情況時,系統會自動傳送訊息給剩餘的工作空間擁有者,通知他們更換已撤銷的權杖。
此外,工作空間中的任何工作空間擁有者皆可撤銷有效權杖。若要撤銷權杖,請點擊該權杖旁邊的 🗑。
更換現有權杖
如果權杖遭到撤銷,您將需要在任何現有的整合中更換它。
任何依賴已撤銷權杖的 SCIM 整合與使用者佈建功能將會停用,直到該權杖被有效的權杖取代為止。
注意: 為避免中斷現有的整合,請務必在取消佈建管理員之前,先取代與其相關聯的任何權杖。
隱藏邀請電子郵件
若要控制使用者在透過 SCIM 佈建時是否會收到加入工作空間與群組的電子郵件邀請,企業版組織擁有者可以:
開啟您的工作空間切換器並選取
管理組織。在
一般分頁中,若您不想傳送電子郵件給使用者,請切換開啟隱藏來自 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。
GET /ServiceProviderConfigGET擷取可用 SCIM 規格功能的說明。
定義於 SCIM 通訊協定規格第 5 節。
GET /ResourceTypesGET擷取可用 SCIM 資源類型的清單。
定義於 SCIM 通訊協定規格第 6 節。
下表概述了 SCIM 使用者屬性與 Notion 使用者個人檔案欄位之間的對應關係。組織擁有者可選擇要傳送哪些屬性至 Notion,並可隨時更新這些屬性。Notion 會處理您透過 Notion SCIM API 傳送的屬性,以改善佈建及管理使用者與群組的體驗。
SCIM 屬性 | Notion 使用者個人檔案欄位 | 外部命名空間 |
|---|---|---|
userName | 電子郵件(本欄位必填) |
|
name.formatted | 姓名(建議使用的姓名欄位。由於 Notion 只有單一姓名欄位,您可以在 Okta 中建立運算式來合併任何姓名欄位。) |
|
name.familyName | 姓名(可與 name.givenName 搭配使用,作為 name.formatted 的替代方案。) |
|
name.givenName | 姓名(可與 name.familyName 搭配使用,作為 name.formatted 的替代方案。) |
|
照片 | 個人檔案照片 |
|
職稱 | 標題 |
|
phoneNumbers | 電話號碼 |
|
addresses | 地址 |
|
角色 | 角色 |
|
Locale | 地區 |
|
preferredLanguage | 偏好語言 |
|
userType | 使用者類型 |
|
電子郵件 | 電子郵件地址 |
|
啟用中 | 有效 |
|
manager.value | Manager(這應該是一個電子郵件地址) |
|
manager.displayName | 經理 |
|
事業部 | 事業部 |
|
部門 | 部門 |
|
costCenter | 成本中心 |
|
組織 | 組織 |
|
employeeNumber | 員工編號 |
|
角色 | Notion 工作空間角色("owner" | "membership_admin" | "member") |
|
注意: Notion 僅儲存 primary=true 的第一個 phoneNumbers 項目。所有其他項目都會被捨棄。type 欄位會被完全忽略。請注意,primary 並非 SCIM 2.0 規格的一部分 — Notion 對其處理方式與標準不同。如果沒有任何項目設為 primary=true,則不會儲存任何電話號碼。
GET /UsersGET檢索工作空間成員的分頁列表。
您可以使用
startIndex和count參數進行分頁。請注意,startIndex是從 1 開始索引,且 count 最大值為 100。您可以使用
filter參數篩選結果。有效的篩選屬性為email、given_name和family_name,例如GET。請注意,
given_name和family_name區分大小寫。電子郵件會轉換為小寫。
GET /Users/GET透過 Notion 使用者 ID 檢索特定的工作空間成員。這將是一個 32 個字元的 UUID,格式如下:
00000000-0000-0000-0000-000000000000。請注意,
meta.created和meta.lastModified不會反映有意義的時間戳記值。
POST /UsersPOST如果您要新增的使用者已經擁有相同電子郵件的 Notion 使用者帳號,則他們將被新增至您的工作空間。
若使用者不存在,呼叫此功能將會建立一個新的 Notion 使用者,並將該使用者新增至您的工作空間。他們將會對應至所建立的 Notion 使用者個人檔案。
SCIM API 會在建立使用者時讀取個人檔案相片屬性,但不會在未來的更新中讀取。
PATCH /Users/PATCH透過一系列操作進行更新,並回傳更新後的使用者記錄。
注意: 只有在您已驗證使用者電子郵件網域的所有權時,才能更新成員的個人檔案資訊(這通常與您為 Notion SAML 單一登入所設定的電子郵件網域相同)。請依照此處的說明驗證您的網域 →
PUT /Users/PUT更新,並回傳更新後的使用者記錄。
DELETE /Users/DELETE從您的工作空間移除使用者。該使用者將會登出所有使用中的工作階段。
使用者帳號無法透過 SCIM 刪除。帳號刪除必須手動執行。
透過傳送
PATCH /Users/或PUT /Users/請求,將active使用者屬性設為false,也能達成從您的工作空間移除使用者的目的。建立 SCIM 機器人權杖的工作空間擁有者無法透過 API 移除。當工作空間擁有者透過 SCIM API 被移除時,他們所建立的任何權杖都將被撤銷,且任何使用該機器人的整合功能都將中斷。
注意: 您可以使用 role 屬性為 使用者 指派工作空間層級,這是現有使用者結構描述的延伸。格式如下:
\"urn:ietf:params:scim:schemas:extension:notion:2.0:User\": { role: string // \"owner\" | \"membership_admin\" | \"member\" }
GET /GroupsGET擷取工作空間群組的分頁列表。
您可以使用
startIndex和count參數進行分頁。請注意startIndex是以 1 為索引起始值,且 count 最大值為 100,例如GET若未使用分頁,單次請求最多會回傳 100 個工作空間群組。
您可以使用
filter參數篩選結果。群組可以透過其displayName屬性進行篩選,例如GET
GET /Groups/GET透過 Notion 群組 ID 擷取特定的工作空間群組。這將是一個 32 字元的 UUID,格式如下:
00000000-0000-0000-0000-000000000000。
POST /GroupsPOST建立新的工作空間群組。
PATCH /Groups/PATCH透過一系列操作更新工作空間群組。
PUT /Groups/PUT更新工作空間群組。
DELETE /Groups/DELETE刪除工作空間群組。
注意: 如果刪除群組會導致沒有人對一個或多個頁面擁有全部權限,則禁止刪除該群組。
