组API 2.0(遗留)

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

请注意

这个API提供的功能也是可用的SCIM API。砖建议您使用这个API。

你一定是一个砖管理员调用此API。

重要的

访问数据砖REST api,你必须进行身份验证。

添加成员

端点

HTTP方法

2.0 /团体/添加成员

帖子

用户或组添加到组。这个调用返回错误RESOURCE_DOES_NOT_EXIST如果一个用户或组的名字不存在,或如果一组给定的父名不存在。

例子

将用户添加到组:

curl——netrc - x\https://1234567890123456.7.gcp.www.neidfyre.com/api/2.0/groups/add-member\——数据”{user_name”:“someone@example.com”、“parent_name”:“reporting-department”}”
{}

添加一个组,另一组:

curl——netrc - x\https://1234567890123456.7.gcp.www.neidfyre.com/api/2.0/groups/add-member\——数据”{group_name”:“reporting-department”、“parent_name”:“data-ops-read-only”}”
{}

请求结构

字段名

类型

描述

user_name或group_name

字符串或字符串

如果user_name,用户名。

如果group_name,组名。

parent_name

字符串

母公司的名称的新成员将被添加。这个字段是必需的。

创建

端点

HTTP方法

2.0 /团体/创建

帖子

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

例子

curl——netrc - x\https://1234567890123456.7.gcp.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如果一组给定的名称是不存在的。这个方法是递归;它返回所有组,属于给定组但不属于这些孩子组的负责人。

例子

curl——netrc - x\https://1234567890123456.7.gcp.www.neidfyre.com/api/2.0/groups/list-members\——数据”{group_name”:“reporting-department“}”\|金桥。
{“成员”:({“user_name”:“someone@example.com”}]}

请求结构

字段名

类型

描述

group_name

字符串

该组织成员我们希望检索。这个字段是必需的。

响应结构

字段名

类型

描述

成员

一个数组的PrincipalName

属于给定组的用户和组。

列表

端点

HTTP方法

2.0 /团体/列表

得到

返回所有的团体在一个组织。

例子

curl——netrc - x\https://1234567890123456.7.gcp.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如果一个用户或组的名字并不存在。

例子

为一个用户组列表:

curl——netrc - x\https://1234567890123456.7.gcp.www.neidfyre.com/api/2.0/groups/list-parents\——数据”{“user_name”:“someone@example.com”}’\|金桥。
{“group_name”:(“reporting-department”]}

为一群家长组列表:

curl——netrc - x\https://1234567890123456.7.gcp.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如果一个用户或组具有给定名称不存在,或者一组给定的父名称不存在。

例子

删除一个用户从一个组:

curl——netrc - x\https://1234567890123456.7.gcp.www.neidfyre.com/api/2.0/groups/remove-member\——数据”{user_name”:“someone@example.com”、“parent_name”:“reporting-department”}”
{}

删除从另一组一组:

curl——netrc - x\https://1234567890123456.7.gcp.www.neidfyre.com/api/2.0/groups/remove-member\——数据”{group_name”:“reporting-department”、“parent_name”:“data-ops-read-only”}”
{}

请求结构

字段名

类型

描述

user_name或group_name

字符串或字符串

如果user_name,用户名。

如果group_name,组名。

parent_name

字符串

母公司的名称的成员将被删除。这个字段是必需的。

删除

端点

HTTP方法

2.0 /团体/删除

帖子

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

例子

curl——netrc - x\https://1234567890123456.7.gcp.www.neidfyre.com/api/2.0/groups/delete\——数据”{group_name”:“reporting-department“}”
{}

请求结构

字段名

类型

描述

group_name

字符串

删除。这个字段是必需的。

数据结构

在本节中:

PrincipalName

容器类型的名称,用户名或组名。

字段名

类型

描述

user_name或group_name

字符串或字符串

如果user_name,用户名。

如果group_name,组名。