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 >与砖工作区实例名例如,dbc-a1b2345c-d6e7.cloud.www.neidfyre.com

这个示例使用. netrc文件和金桥

通过ID获取组

端点

HTTP方法

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

得到

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

示例请求

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

替换:

  • < databricks-instance >与砖工作区实例名例如,dbc-a1b2345c-d6e7.cloud.www.neidfyre.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 >与砖工作区实例名例如,dbc-a1b2345c-d6e7.cloud.www.neidfyre.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 >与砖工作区实例名例如,dbc-a1b2345c-d6e7.cloud.www.neidfyre.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 >与砖工作区实例名例如,dbc-a1b2345c-d6e7.cloud.www.neidfyre.com

  • <组id >组的ID的砖工作区,例如2345678901234567。组ID,电话获得团体

这个示例使用. netrc文件。

你也可以添加角色一组或删除角色从一组使用SCIM API。

添加角色组的ID

端点

HTTP方法

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

补丁

旋度——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 >”}]}]}

替换:

  • < databricks-instance >与砖工作区实例名例如,dbc-a1b2345c-d6e7.cloud.www.neidfyre.com

  • <组id >组的ID的砖工作区,例如2345678901234567。组ID,电话获得团体

  • < role-arn >与亚马逊的资源名称(攻击)的角色,例如攻击:aws:我::123456789012:/我的角色作用

这个示例使用. netrc文件和金桥

删除角色从一组ID

端点

HTTP方法

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

补丁

旋度——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 > \]”}]}

替换:

  • < databricks-instance >与砖工作区实例名例如,dbc-a1b2345c-d6e7.cloud.www.neidfyre.com

  • <组id >组的ID的砖工作区,例如2345678901234567。组ID,电话获得团体

  • < role-arn >与亚马逊的资源名称(攻击)的角色,例如攻击:aws:我::123456789012:/我的角色作用

这个示例使用. netrc文件和金桥