SCIM API 2.0 (ServicePrincipals)工作區

重要的

這篇文章的內容已經退休,可能不會被更新。看到服務主體磚的REST API參考。

預覽

這個特性是在公共預覽。

這是文章的引用工作空間層SCIM API服務主體。

您可以使用SCIM (ServicePrincipals)來創建、讀取、更新和刪除數據磚服務主體。工作區管理也可以創建或取消個人訪問令牌服務主體的代表。您還可以使用這個API列表和閱讀信息服務主體。

使用api來提供信息服務主體直接存入你的帳戶相反,看到的SCIM API 2.0(賬戶)。信息使用帳戶級別或工作空間層SCIM供應時,看到的_。

錯誤代碼,請參閱_。

需求

你的磚賬戶必須有保費計劃。

得到服務主體

端點

HTTP方法

2.0 /預覽/ scim / v2 / ServicePrincipals

得到

檢索的列表中的所有服務主體磚工作區。

當調用一個非管理用戶,隻有用戶名,用戶顯示名稱和對象返回。

例子

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

您可以使用過濾器指定服務主體的子集。例如,您可以應用情商(=)濾波器參數applicationId檢索一個特定的服務主體:

curl——netrc - x\“https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 / ServicePrincipals ?過濾器= applicationId + eq + <應用程序id >”\|金橋。

在工作區與大量的服務主體,可以排除屬性從請求來提高性能。

curl——netrc - x\“https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 / ServicePrincipals ? excludedAttributes =權益團體”\|金橋。

替換:

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

  • <應用程序id >與applicationId例如,服務主體的價值12345 a67 - 8 b9c - 0 - d1e - 23 - fa - 4567 b89cde01。

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

通過ID獲取服務主體

端點

HTTP方法

2.0 /預覽/ scim / v2 / ServicePrincipals / {id}

得到

檢索一個服務主體資源從磚工作區,給定一個服務主體ID。

例子

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

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

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

創建服務主體

端點

HTTP方法

2.0 /預覽/ scim / v2 / ServicePrincipals

帖子

創建一個服務主體的磚工作區。服務主體將自動被添加到帳戶。看到如何磚同步的工作區和帳戶之間的身份?。服務主體計入10000用戶的工作空間的極限。

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

請注意

的applicationId是隨機生成的。在一個身份聯合工作空間,您可以指定applicationId服務主體的戶頭級別服務主體分配到您的工作空間中。

每個服務主體都有一個獨一無二的applicationId。然而,多個服務主體可以有相同的顯示名稱。

例子

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

create-service-principal.json:

{“displayName”:“<顯示名稱>”,“權利”:({“價值”:“allow-cluster-create”}),“組織”:({“價值”:“<組id >”}),“模式”:(“urn: ietf:參數:scim:模式:核心:2.0:ServicePrincipal”),“活躍”:真正的}

替換:

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

  • <顯示名稱>顯示名稱的服務主體,例如someone@example.com。

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

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

列出可用的權利的磚身份類型,見:

更新服務主體通過ID(補丁)

端點

HTTP方法

2.0 /預覽/ scim / v2 / ServicePrincipals / {id}

補丁

更新一個服務主體對特定資源與操作屬性,除了displayName,applicationId,id,這是不可變的。

使用補丁方法來添加、更新或刪除單個屬性。使用PUT方法覆蓋整個服務主體在單個操作。

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

添加權限

例子

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

change-service-principal.json:

{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“添加”,“路徑”:“權利”,“價值”:({“價值”:“allow-cluster-create”}]}]}

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

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

列出可用的權利的磚身份類型,見:

刪除權利

例子

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

change-service-principal.json:

{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“刪除”,“路徑”:“權利”,“價值”:({“價值”:“allow-cluster-create”}]}]}

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

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

列出可用的權利的磚身份類型,見:

增加一組

例子

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

change-service-principal.json:

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

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

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

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

刪除從一群

例子

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

remove-from-group.json:

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

替換:

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

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

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

停用服務主體的ID

停用服務主體,設置它活躍的屬性來假。停用服務主體不會自動清除。

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

deactivate-service-principal.json:

{“模式”:(“urn: ietf:參數:scim: api:消息:2.0:PatchOp”),“操作”:({“人事處”:“替換”,“路徑”:“活躍”,“價值”:({“價值”:“假”}]}]}

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

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

更新服務主體通過ID(把)

端點

HTTP方法

2.0 /預覽/ scim / v2 / ServicePrincipals / {id}

把

覆蓋整個服務主體資源,除了displayName,applicationId,id,這是不可變的。

使用修補方法添加、更新或刪除單個屬性。

重要的

你必須包括模式屬性的請求,與精確值urn: ietf:參數:scim:模式:核心:2.0:ServicePrincipal。

例子

添加一個權利

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

update-service-principal.json:

{“模式”:(“urn: ietf:參數:scim:模式:核心:2.0:ServicePrincipal”),“applicationId”:“< applicationId-id >”,“displayName”:“<顯示名稱>”,“組織”:({“價值”:“<組id >”}),“權利”:({“價值”:“allow-cluster-create”}]}

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

  • <應用程序id >與applicationId例如,服務主體的價值12345 a67 - 8 b9c - 0 - d1e - 23 - fa - 4567 b89cde01。

  • <顯示名稱>顯示名稱的服務主體,例如someone@example.com。

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

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

列出可用的權利的磚身份類型,見:

刪除所有權利和組

刪除所有權利和組是一個可逆的選擇刪除服務主體。

使用把方法以避免需要檢查現有權利和組成員關係。

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

update-service-principal.json:

{“模式”:(“urn: ietf:參數:scim:模式:核心:2.0:ServicePrincipal”),“applicationId”:“<應用程序id >”,“displayName”:“<顯示名稱>”,“組織”:[],“權利”:[]}

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

  • <應用程序id >與applicationId例如,服務主體的價值12345 a67 - 8 b9c - 0 - d1e - 23 - fa - 4567 b89cde01。

  • <顯示名稱>顯示名稱的服務主體,例如someone@example.com。

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

刪除服務主體的ID

端點

HTTP方法

2.0 /預覽/ scim / v2 / ServicePrincipals / {id}

刪除

刪除一個服務主體的資源。該操作不可逆。

例子

curl——netrc - x刪除\https:// < databricks-instance > / api / 2.0 /預覽/ scim / v2 / ServicePrincipals / < service-principal-id >

替換:

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

  • < service-principal-id >服務主體的ID,例如2345678901234567。服務主體的ID,電話得到服務主體。

這個示例使用. netrc文件。

是一種可逆的選擇,你可以刪除所有的權利和組而不是刪除服務主體。