組API 2.0(遺留)

組API(遺留)允許您管理用戶組。

請注意

這個API提供的功能也是可用的SCIM API。磚建議您使用這個API。

你一定是一個磚管理員調用此API。

重要的

訪問數據磚REST api,你必須進行身份驗證。

添加成員

端點

HTTP方法

2.0 /團體/添加成員

帖子

用戶或組添加到組。這個調用返回錯誤RESOURCE_DOES_NOT_EXIST如果一個用戶或組的名字不存在,或如果一組給定的父名不存在。

請注意

你不能用這個調用聯合身份驗證工作區。使用SCIM API 2.0(賬戶)組織和管理帳戶SCIM(集團)API管理workspace-local組。有關更多信息,請參見特殊注意事項集團。

例子

將用戶添加到組:

curl——netrc - x\https://dbc-a1b2345c-d6e7.cloud.www.eheci.com/api/2.0/groups/add-member\——數據”{user_name”:“someone@example.com”、“parent_name”:“reporting-department”}”
{}

添加一個組,另一組:

curl——netrc - x\https://dbc-a1b2345c-d6e7.cloud.www.eheci.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如果一組給定的名稱已經存在。

請注意

你不能用這個調用聯合身份驗證工作區。使用SCIM API 2.0(賬戶)組織和創建帳戶SCIM(集團)API創建workspace-local組。有關更多信息,請參見特殊注意事項集團。

例子

curl——netrc - x\https://dbc-a1b2345c-d6e7.cloud.www.eheci.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://dbc-a1b2345c-d6e7.cloud.www.eheci.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://dbc-a1b2345c-d6e7.cloud.www.eheci.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://dbc-a1b2345c-d6e7.cloud.www.eheci.com/api/2.0/groups/list-parents\——數據”{“user_name”:“someone@example.com”}’\|金橋。
{“group_name”:(“reporting-department”]}

為一群家長組列表:

curl——netrc - x\https://dbc-a1b2345c-d6e7.cloud.www.eheci.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(集團)API管理workspace-local組。有關更多信息,請參見特殊注意事項集團。

例子

刪除一個用戶從一個組:

curl——netrc - x\https://dbc-a1b2345c-d6e7.cloud.www.eheci.com/api/2.0/groups/remove-member\——數據”{user_name”:“someone@example.com”、“parent_name”:“reporting-department”}”
{}

刪除從另一組一組:

curl——netrc - x\https://dbc-a1b2345c-d6e7.cloud.www.eheci.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://dbc-a1b2345c-d6e7.cloud.www.eheci.com/api/2.0/groups/delete\——數據”{group_name”:“reporting-department“}”
{}

請求結構

字段名

類型

描述

group_name

字符串

刪除。這個字段是必需的。

數據結構

在本節中:

PrincipalName

容器類型的名稱,用戶名或組名。

字段名

類型

描述

user_name或group_name

字符串或字符串

如果user_name,用戶名。

如果group_name,組名。