Groups API 2.0(遗留)

Groups API(遗留)允许您管理用户组。

请注意

类中也提供了此API提供的功能SCIM API．Databricks建议您改用该API。

你一定是个数据专家管理员调用此API。

重要的

要访问Databricks REST api，必须进行身份验证．

添加成员

端点

HTTP方法

2.0 /团体/添加成员

帖子

将用户或组添加到组中。这个调用返回错误RESOURCE_DOES_NOT_EXIST如果具有给定名称的用户或组不存在，或者具有给定父名称的组不存在。

请注意

您不能使用此呼叫联合身份验证工作区。使用SCIM API 2.0(帐户)管理帐户组和SCIM (Groups) API管理工作空间-本地组。有关更多信息，请参见团体特别注意事项．

例子

添加用户到组。

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/add-member＼——数据'{"user_name": "someone@example.com"， "parent_name": "报表部门"}'
{}

将一个组添加到另一个组。

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/add-member＼——数据“{"group_name": "report -department"， "parent_name": "data-ops-read-only"}”
{}

请求结构

字段名

类型

描述

user_name或group_name

字符串或字符串

user_name:用户名。

如果是group_name，则组名。

parent_name

字符串

新成员要添加到的父组的名称。该字段为必填项。

创建

端点

HTTP方法

2.0 /团体/创建

帖子

用给定的名称创建一个新组。这个调用返回一个错误RESOURCE_ALREADY_EXISTS如果具有给定名称的组已经存在。

请注意

您不能使用此呼叫联合身份验证工作区。使用SCIM API 2.0(帐户)创建帐户组和SCIM (Groups) API要创建工作空间-本地组。有关更多信息，请参见团体特别注意事项．

例子

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/create＼——数据“{"group_name": "reporting-department"}”
｛“group_name”：“reporting-department”｝

请求结构

字段名

类型

描述

group_name

字符串

组的名称;在该组织所拥有的组中必须是唯一的。该字段为必填项。

响应结构

字段名

类型

描述

group_name

字符串

组名。

成员列表

端点

HTTP方法

2.0 /组织/国家

得到

返回特定组的所有成员。这个调用返回错误RESOURCE_DOES_NOT_EXIST如果给定名称的组不存在。这个方法是非递归的;它返回属于给定组的所有组，但不返回属于这些子组的主体。

例子

—netrc -X GET＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/list-members＼——数据“{"group_name": "reporting-department"}”＼|金桥。
｛“成员”：［｛“user_name”：“someone@example.com”｝］｝

请求结构

字段名

类型

描述

group_name

字符串

我们要检索其成员的组。该字段为必填项。

响应结构

字段名

类型

描述

成员

的数组PrincipalName

属于给定组的用户和组。

列表

端点

HTTP方法

2.0 /团体/列表

得到

返回组织中的所有组。

例子

—netrc -X GET＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/list＼|金桥。
｛“group_name”：［“reporting-department”，“data-ops-read-only”，“管理员”］｝

响应结构

字段名

类型

描述

group_name

的数组字符串

这个组织中的小组。

列表的父母

端点

HTTP方法

2.0 /团体/ list-parents

得到

检索给定用户或组所属的所有组。这个方法是非递归的;它返回给定用户或组所属的所有组，但不返回这些组所属的组。这个调用返回错误RESOURCE_DOES_NOT_EXIST如果具有给定名称的用户或组不存在。

例子

列出用户的组。

—netrc -X GET＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/list-parents＼——数据'{"user_name": "someone@example.com"}'＼|金桥。
｛“group_name”：［“reporting-department”］｝

列出一个组的父组。

—netrc -X GET＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/list-parents＼——数据“{"group_name": "reporting-department"}”＼|金桥。
｛“group_name”：［“data-ops-read-only”］｝

请求结构

字段名

类型

描述

user_name或group_name

字符串或字符串

user_name:用户名。

如果是group_name，则组名。

响应结构

字段名

类型

描述

group_name

的数组字符串

给定用户或组所属的组。

删除成员

端点

HTTP方法

2.0 /团体/ remove-member

帖子

从组中移除用户或组。这个调用返回错误RESOURCE_DOES_NOT_EXIST如果具有给定名称的用户或组不存在，或者具有给定父名称的组不存在。

请注意

您不能使用此呼叫联合身份验证工作区。使用SCIM API 2.0(帐户)管理帐户组和SCIM (Groups) API管理工作空间-本地组。有关更多信息，请参见团体特别注意事项．

例子

将用户从组中移除。

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/remove-member＼——数据'{"user_name": "someone@example.com"， "parent_name": "报表部门"}'
{}

从另一个组中删除一个组:

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/remove-member＼——数据“{"group_name": "report -department"， "parent_name": "data-ops-read-only"}”
{}

请求结构

字段名

类型

描述

user_name或group_name

字符串或字符串

user_name:用户名。

如果是group_name，则组名。

parent_name

字符串

要从其中删除成员的父组的名称。该字段为必填项。

删除

端点

HTTP方法

2.0 /团体/删除

帖子

从该组织中删除一个组。这个调用返回错误RESOURCE_DOES_NOT_EXIST如果给定名称的组不存在。

例子

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.www.neidfyre.com/api/2.0/groups/delete＼——数据“{"group_name": "reporting-department"}”
{}

请求结构

字段名

类型

描述

group_name

字符串

该组要移除。该字段为必填项。

数据结构

本节:

PrincipalName

对于用户名或组名的名称，容器类型。

字段名

类型

描述

user_name或group_name

字符串或字符串

user_name:用户名。

如果是group_name，则组名。