SCIM API 2.0(集團)工作區
重要的
這篇文章的內容已經退休,可能不會被更新。看到組磚的REST API參考。
預覽
這個特性是在公共預覽。
這是一個參考文章組織的工作空間層SCIM API。
您可以使用SCIM(集團)API來創建workspace-local組在磚的工作空間,給他們適當的訪問級別,刪除訪問組(去除),並從組添加角色、刪除角色。您還可以使用這個API列表和閱讀有關組織的信息。
信息使用api來提供組織你的賬戶相反,看到的SCIM API 2.0(賬戶)。
信息使用帳戶級別或工作空間層SCIM供應時,看到的_。
錯誤代碼,請參閱_。
需求
你的磚賬戶必須有保費計劃或以上。
獲得團體
端點 |
HTTP方法 |
|---|---|
|
|
管理用戶:檢索在磚工作區中所有組的列表。
非管理用戶:檢索在磚工作區中所有組的列表,返回組顯示名稱和對象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 >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.m.eheci.com。
創建組
端點 |
HTTP方法 |
|---|---|
|
|
管理用戶:創建一個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 >或< service-principal-id >”}),“權利”:({“價值”:“< entitlement-id >”}]}
替換:
< databricks-instance >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.m.eheci.com。<組名稱>與集團的名稱磚工作區,例如我的小組。<用戶id >磚工作空間的用戶的ID,例如2345678901234567。用戶ID,電話讓用戶。< service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。< entitlement-id >ID名稱的權利,例如workspace-access,allow-cluster-create,或databricks-sql-access。
更新組
端點 |
HTTP方法 |
|---|---|
|
|
管理用戶:更新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 >或< service-principal-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 >與磚工作區實例名例如,dbc-a1b2345c-d6e7.cloud.m.eheci.com。<組id >組的ID的磚工作區,例如2345678901234567。組ID,電話獲得團體。<用戶id >磚工作空間的用戶的ID,例如2345678901234567。用戶ID,電話讓用戶。< service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。< entitlement-id >ID名稱的權利,例如workspace-access,allow-cluster-create,或databricks-sql-access。
你也可以添加角色一組或刪除角色從一組使用SCIM API。
添加角色組的ID
端點 |
HTTP方法 |
|---|---|
|
|
旋度——netrc - x的補丁\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /團體/ <組id >\——頭內容類型:應用程序/ scim + json的\——數據@add-role-to-group.json\|金橋。
add-role-to-group.json:
{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“添加”,“路徑”:“角色”,“價值”:({“價值”:“< role-arn >或< instance-profile-role-arn >”}]}]}
替換:
刪除角色從一組ID
端點 |
HTTP方法 |
|---|---|
|
|
旋度——netrc - x的補丁\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 /團體/ <組id >\——頭內容類型:應用程序/ scim + json的\——數據@remove-role-from-group.json\|金橋。
remove-role-from-group.json:
{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“刪除”,“路徑”:“角色(eq值\“< role-arn >或< instance-profile-role-arn > \”)”}]}
替換: