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.m.eheci.com/api/2.0/groups/add-member＼——數據'{"user_name": "someone@example.com"， "parent_name": "報表部門"}'
{}

將一個組添加到另一個組。

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.m.eheci.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.m.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如果給定名稱的組不存在。這個方法是非遞歸的;它返回屬於給定組的所有組，但不返回屬於這些子組的主體。

例子

—netrc -X GET＼https://dbc-a1b2345c-d6e7.cloud.m.eheci.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.m.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如果具有給定名稱的用戶或組不存在。

例子

列出用戶的組。

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

列出一個組的父組。

—netrc -X GET＼https://dbc-a1b2345c-d6e7.cloud.m.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 (Groups) API管理工作空間-本地組。有關更多信息，請參見團體特別注意事項．

例子

將用戶從組中移除。

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.m.eheci.com/api/2.0/groups/remove-member＼——數據'{"user_name": "someone@example.com"， "parent_name": "報表部門"}'
{}

從另一個組中刪除一個組:

—netrc -X POST＼https://dbc-a1b2345c-d6e7.cloud.m.eheci.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.m.eheci.com/api/2.0/groups/delete＼——數據“{"group_name": "reporting-department"}”
{}

請求結構

字段名

類型

描述

group_name

字符串

該組要移除。該字段為必填項。

數據結構

本節:

PrincipalName

對於用戶名或組名的名稱，容器類型。

字段名

類型

描述

user_name或group_name

字符串或字符串

user_name:用戶名。

如果是group_name，則組名。