工作空间的SCIM API 2.0(组)

预览

此功能已在公共预览．

这是一篇用于组的工作空间级SCIM API的参考文章。

您可以使用SCIM (Groups) API来创建workspace-local组在Databricks工作区中，给它们适当的访问级别，并删除组的访问权限(取消它们的配置)。您还可以使用此API列出和读取有关组的信息。

有关使用api为帐户提供组的信息，请参见SCIM API 2.0(帐户)．

有关何时使用帐户级或工作区级SCIM配置的信息，请参见帐户级和工作空间级的SCIM．

有关错误代码，请参见SCIM API 2.0错误代码．

需求

您的Databricks帐户必须具有Databricks高级计划．

请注意

  • 一个砖工作空间管理员可以调用所有SCIM API端点。

  • 非管理员用户可以调用获得团体端点读取组显示的名称和id。

  • 工作区中的用户不能超过10,000个，组不能超过5,000个。

获得团体

端点

HTTP方法

2.0 /预览/ scim / v2 /组

得到

管理用户:检索Databricks工作区中所有组的列表。

非admin用户:检索Databricks工作区中所有组的列表，只返回组显示名称和对象ID。

例子

—netrc -X GET＼https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /组＼|金桥。

你可以使用过滤器指定组的子集。例如，您可以应用西南(以)过滤器参数开始displayName检索特定组或组集。此示例检索具有displayName字段，以我- - - - - -．

—netrc -X GET＼“https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /团体?过滤器= displayName +软件+我-”＼|金桥。

取代< databricks-instance >和数据库工作空间实例名称例如，1234567890123456.7.gcp.www.neidfyre.com．

本例使用. netrc文件和金桥．

按ID获取分组

端点

HTTP方法

2.0 /预览/ scim / v2 /团体/ {id}

得到

管理用户:检索单个组资源。

示例请求

—netrc -X GET＼https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /团体/ <组id >＼|金桥。

替换:

  • < databricks-instance >和数据库工作空间实例名称例如，1234567890123456.7.gcp.www.neidfyre.com．

  • <组id >例如，Databricks工作区中的组ID2345678901234567．要获取组ID，请呼叫获得团体．

本例使用. netrc文件和金桥．

创建组

端点

HTTP方法

2.0 /预览/ scim / v2 /组

帖子

管理员用户:创建workspace-local集团在砖。

请求参数遵循标准的SCIM 2.0协议。

请求必须包含以下属性:

  • 模式设置为urn: ietf:参数:scim:模式:核心:2.0:集团

  • displayName

成员List是可选的，可以包括用户和其他组。还可以使用补丁．

例子

—netrc -X POST＼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.www.neidfyre.com．

  • <组名称>例如，Databricks工作区中的组名我的小组．

  • <用户id >例如，使用用户的Databricks工作区ID2345678901234567．要获取用户ID，请调用让用户．

  • < entitlement-id >使用授权的ID名称，例如workspace-access，allow-cluster-create,或databricks-sql-access．

本例使用. netrc文件和金桥．

更新组

端点

HTTP方法

2.0 /预览/ scim / v2 /团体/ {id}

补丁

管理员用户:更新aworkspace-local集团在Databricks工作区中添加或删除成员。可以在组中添加和删除单个成员或组。

请求参数遵循标准的SCIM 2.0协议，并依赖于模式属性。

请注意

Databricks不支持更新组名。

例子

curl—netrc -X PATCH＼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”),“操作”:［｛“人事处”:“删除”，“路径”:"member [value eq \"\"]"｝］｝

添加权限

update-group.json:

｛“模式”:［“urn: ietf:参数:scim: api:消息:2.0:PatchOp”),“操作”:［｛“人事处”:“添加”，“价值”:｛“权利”:［｛“价值”:“< entitlement-id >”｝］｝｝］｝

移除授权

update-group.json:

｛“模式”:［“urn: ietf:参数:scim: api:消息:2.0:PatchOp”),“操作”:［｛“人事处”:“删除”，“路径”:"value eq \"< title -id>\""｝］｝

替换:

  • < databricks-instance >和数据库工作空间实例名称例如，1234567890123456.7.gcp.www.neidfyre.com．

  • <组id >例如，Databricks工作区中的组ID2345678901234567．要获取组ID，请呼叫获得团体．

  • <用户id >例如，使用用户的Databricks工作区ID2345678901234567．要获取用户ID，请调用让用户．

  • < entitlement-id >使用授权的ID名称，例如workspace-access，allow-cluster-create,或databricks-sql-access．

本例使用. netrc文件和金桥．

删除组

端点

HTTP方法

2.0 /预览/ scim / v2 /团体/ {id}

删除

管理用户:从Databricks工作区中删除一个组。组内用户未被删除。

例子

—netrc -X DELETE＼https:// < databricks-instance > / api / 2.0 /预览/ scim / v2 /团体/ <组id >

替换:

  • < databricks-instance >和数据库工作空间实例名称例如，1234567890123456.7.gcp.www.neidfyre.com．

  • <组id >例如，Databricks工作区中的组ID2345678901234567．要获取组ID，请呼叫获得团体．

本例使用. netrc文件。