SCIM API 2.0(集團)工作區

預覽

這個特性是在公共預覽

這是一個參考文章組織的工作空間層SCIM API。

您可以使用SCIM(集團)API來創建workspace-local組在磚的工作空間,給他們適當的訪問級別,刪除訪問組(去除)。您還可以使用這個API列表和閱讀有關組織的信息。

信息使用api來提供組織你的賬戶相反,看到的SCIM API 2.0(賬戶)

信息使用帳戶級別或工作空間層SCIM供應時,看到的帳戶級別和工作空間層SCIM供應

錯誤代碼,請參閱SCIM API 2.0錯誤代碼

需求

你的磚賬戶必須有磚溢價的計劃

請注意

  • 一個磚工作空間管理員可以調用所有SCIM API端點。

  • 非管理用戶可以調用獲得團體端點閱讀組顯示名稱和id。

  • 你可以有不超過10000個用戶和5000組在一個工作區。

獲得團體

端點

HTTP方法

2.0 /預覽/ scim / v2 /組

得到

管理用戶:檢索在磚工作區中所有組的列表。

非管理用戶:檢索在磚工作區中所有組的列表,返回組顯示名稱和對象ID。

例子

curl——netrc - x\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /組\|金橋。

您可以使用過濾器指定組的子集。例如,您可以應用西南(開始)濾波器參數displayName檢索一個特定的群體或團體。這個例子中檢索所有群體displayName場開始我- - - - - -

curl——netrc - x\“https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /團體?過濾器= displayName +軟件+我-”\|金橋。

取代< databricks-instance >與磚工作區實例名例如,1234567890123456.7.gcp.m.eheci.com

這個示例使用. netrc文件和金橋

通過ID獲取組

端點

HTTP方法

2.0 /預覽/ scim / v2 /團體/ {id}

得到

管理用戶:檢索單個組資源。

示例請求

curl——netrc - x\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /團體/ <組id >\|金橋。

替換:

  • < databricks-instance >與磚工作區實例名例如,1234567890123456.7.gcp.m.eheci.com

  • <組id >組的ID的磚工作區,例如2345678901234567。組ID,電話獲得團體

這個示例使用. netrc文件和金橋

創建組

端點

HTTP方法

2.0 /預覽/ scim / v2 /組

帖子

管理用戶:創建一個workspace-local集團在磚。

請求參數遵循標準的SCIM 2.0協議。

請求必須包含以下屬性:

  • 模式設置為urn: ietf:參數:scim:模式:核心:2.0:集團

  • displayName

成員是可選的,可以包括用戶列表和其他團體。您還可以使用一組添加成員補丁

例子

curl——netrc - x\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /組\——頭內容類型:應用程序/ scim + json的\——數據@create-group.json\|金橋。

create-group.json:

{“模式”:(“urn: ietf:參數:scim:模式:核心:2.0:集團”),“displayName”:“<組名稱>”,“成員”:({“價值”:“<用戶id >”}),“權利”:({“價值”:“< entitlement-id >”}]}

替換:

  • < databricks-instance >與磚工作區實例名例如,1234567890123456.7.gcp.m.eheci.com

  • <組名稱>與集團的名稱磚工作區,例如我的小組

  • <用戶id >磚工作空間的用戶的ID,例如2345678901234567。用戶ID,電話讓用戶

  • < entitlement-id >ID名稱的權利,例如workspace-access,allow-cluster-create,或databricks-sql-access

這個示例使用. netrc文件和金橋

更新組

端點

HTTP方法

2.0 /預覽/ scim / v2 /團體/ {id}

補丁

管理用戶:更新workspace-local集團在磚工作區添加或刪除成員。可以添加和刪除個別成員的組內或組。

請求參數遵循標準SCIM 2.0協議和依賴的價值模式屬性。

請注意

磚不支持更新組名稱。

例子

旋度——netrc - x的補丁\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /團體/ <組id >\——頭內容類型:應用程序/ scim + json的\——數據@update-group.json\|金橋。

添加到組

update-group.json:

{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“添加”,“價值”:{“成員”:({“價值”:“<用戶id >”}]}}]}

刪除從組

update-group.json:

{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“刪除”,“路徑”:“成員(eq值\“<用戶id > \]”}]}

添加一個權利

update-group.json:

{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“添加”,“價值”:{“權利”:({“價值”:“< entitlement-id >”}]}}]}

刪除一個權利

update-group.json:

{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“刪除”,“路徑”:“價值eq \”< entitlement-id > \”“}]}

替換:

  • < databricks-instance >與磚工作區實例名例如,1234567890123456.7.gcp.m.eheci.com

  • <組id >組的ID的磚工作區,例如2345678901234567。組ID,電話獲得團體

  • <用戶id >磚工作空間的用戶的ID,例如2345678901234567。用戶ID,電話讓用戶

  • < entitlement-id >ID名稱的權利,例如workspace-access,allow-cluster-create,或databricks-sql-access

這個示例使用. netrc文件和金橋

刪除組

端點

HTTP方法

2.0 /預覽/ scim / v2 /團體/ {id}

刪除

管理用戶:把一組從一個磚的工作區。用戶組不刪除。

例子

curl——netrc - x刪除\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /團體/ <組id >

替換:

  • < databricks-instance >與磚工作區實例名例如,1234567890123456.7.gcp.m.eheci.com

  • <組id >組的ID的磚工作區,例如2345678901234567。組ID,電話獲得團體

這個示例使用. netrc文件。