用户组端点
用户组端点和参数
要详细了解对象关系以及如何在 API 中使用对象关系，请转至 对象关系 部分。
如需详细了解 Server 用户组，请访问 用户和组管理 帮助页面。
创建新的用户组
要创建新的用户组，请使用
POST {baseURL}/v3/usergroups
端点。
注意
只有管理员可以使用此 API 端点。
参数
要创建新的 Server 用户组，请指定 contract 参数：
contract (body)：必填。指定 Server 用户组的参数：
name (string)：必填。输入 Server 用户组名称。
role (string)：必填。输入此 Server 用户组的角色。从以下选项中进行选择：无访问权限、查看者、成员、创建者、管理员和已评估。默认（已评估）角色在运行时已评估。如需详细了解角色和权限，请访问 用户角色和权限 页面。
请求示例：cURL
curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'
将用户添加到用户组
要向现有用户组添加一个或多个现有用户，请使用
POST {baseURL}/v3/usergroups/{userGroupId}/users
端点。
注意
只有管理员可以使用此 API 端点。
参数
要将用户添加到 Server 用户组，请指定以下参数：
userGroupId (string)：必填。输入要向其中添加用户的用户组的 ID。
userIds (body)：必填。输入要添加到此用户组的用户 ID 列表，以逗号分隔。
将 Active Directory 组添加到用户组
要向现有用户组添加 Active Directory 组，请使用
POST /v3/usergroups/{userGroupId}/activedirectorygroups
端点。
注意
只有管理员可以使用此 API 端点。
此端点只能用于配置了 Windows 身份验证的 Server 实例。
参数
userGroupId (string)：必填。输入要向其中添加 Active Directory 组的现有用户组的 ID。
sid (string)：必填。输入 Active Directory 组的安全标识符 (SID)。这是 JSON 格式的正文的实际数据。您必须提交以双引号括住的值，例如提交“S-My-SID”。
检索所有用户组
要检索所有可访问的用户组记录，请使用
GET {baseURL}/v3/usergroups
端点。使用各种参数作为筛选条件来搜索用户。
注意
只有管理员可以使用此 API 端点。
系统将只检索自定义用户组。不会返回任何 Active Directory 组。
参数
无需提供参数。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
检索特定用户组的详细信息
要检索有关现有用户组的详细信息，请使用
GET {baseURL}/v3/usergroups/{userGroupId}
端点。
注意
只有管理员可以使用此 API 端点。
仅适用于 Server 用户组。无法从此端点检索 Active Directory 组。
参数
userGroupId (string)：必填。输入现有用户组 ID 以检索有关此用户组的信息。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
更新用户组
要更新现有用户组的名称和角色，请使用
PUT {baseURL}/v3/usergroups/{userGroupId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
userGroupId (string)：必填。输入用户组 ID 以更新此用户组。
contract (body)：必填。要更新用户组，必须指定 contract 参数。请指定以下参数：
name (string)：必填。输入用户组名称。
role (string)：必填。您可以从以下选项中进行选择：无访问权限、查看者、成员、创建者、管理员和已评估。如需详细了解角色和权限，请访问 用户角色和权限 页面。
请求示例：cURL
curl --location --request PUT 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'
从用户组中移除用户
要从现有用户组中移除特定用户，请使用
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
端点。
注意
只有管理员可以使用此 API 端点。
如果用户不属于用户组，则将返回 OK（正常）响应。
参数
userGroupId (string)：必填。输入要从中移除用户的用户组的 ID。
userId (string)：必填。输入要从用户组中移除的用户 ID。
请求示例：cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从用户组中移除 Active Directory 组
要从现有用户组中移除 Active Directory 组，请使用
DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}
端点。
注意
只有管理员可以使用此 API 端点。
此端点只能用于配置了 Windows 身份验证的 Server 实例。
参数
userGroupId (string)：必填。输入要从中移除 Active Directory 组的用户组的标识符。
adGroupSid (string)：必填。输入要从用户组中移除的 Active Directory 组的安全标识符 (SID)。
删除用户组
要从系统中删除现有用户组，请使用
DELETE {baseURL}/v3/usergroups/{userGroupId}
端点。
注意
只有管理员可以使用此 API 端点。
如果用户组不为空且 forceDelete 查询参数为 false，则会返回“400 错误请求”错误消息。
参数
userGroupId (string)：必填。输入要删除的用户组 ID。
forceDelete (boolean)：可选。如果设置为 true，则即使此用户组包含用户，也将予以删除。
请求示例：cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
对象关系
如果您要创建用户组，则可以按如下方式使用创建的对象：
创建的对象：“ id ”（例如，“id”: “619158e57e607d0011ac3009”）
您可以将其用作：
userGroupId （如果您要 将用户组添加到集合 ）。
userGroupId （如果您要 更新集合的用户组权限 ）。
userGroupId （如果您要 从集合中移除用户组 ）。
userGroupId （如果要 与用户组共享凭证 ）。
userGroupId （如果要 从凭证中移除用户组 ）。
userGroupId （如果要 将用户组添加到数据连接 ）。
userGroupId （如果要 从数据连接中移除用户组 ）。
Postman 请求示例
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
如需详细了解有关 Postman 请求的更多信息，请访问 如何使用 Postman 帮助页面。