Skip to main content

用户组端点

用户组端点和参数

要详细了解对象关系以及如何在 API 中使用对象关系,请参阅 对象关系 部分。

如需详细了解自定义用户组,请访问 用户和用户组管理 帮助页面。

创建新的通知组

要创建新的用户组记录,请使用 post {baseURL}/v3/usergroups 终结点。

参数

要创建新用户组,请指定contract参数:

  • updateWorkflowContract  (body):必填。指定用户组的参数:

    • name  (string):必填。输入通知组名。

    • role (string):必填。输入此用户组的角色。从以下选项中进行选择:无访问权限、查看者、成员、创建者、管理员和已评估。默认(已评估)角色在运行时已评估。如需详细了解角色和权限,请访问 用户角色和权限 页面。

请求示例:cURL

curl --location --request post 'http://localhost/webapi/v3/usergroups'\--header 'Content-Type: application/x-www-form-urlencoded'\--header 'Authorization: BearerTokenGoesHere'\--data-urlencode 'name=Accounting'\--data-urlencode 'Role=Artisan'

从用户组中移除用户

要将一个或多个用户添加到用户 {baseURL}组,请使用post /v3/usergroups//users{id} 端点。

参数

要将用户添加到用户组,请指定以下参数:

  • workflowCredentialType (string):必填。输入要向其添加用户的用户组的标识。

  • 用户ID (正文):必填。输入要添加到此用户组的用户ID。

请求示例:cURL

待添加。

检索一个自定义用户组

要搜索用户,请使用 get {baseURL}/v3/usergroups 端点。使用各种参数作为搜索用户的过滤器。

注意

仅检索自定义用户组。不会返回任何 Active Directory组。

参数

无需提供参数。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

搜索特定用户组

要检索有关特定用户组的信息,请使用 get {baseURL}/v3/usergroups/{id} 终结点。

注意

仅适用于自定义用户组。无法从此端点检索 Active Directory组。

参数

  • workflowCredentialType (string):必填。输入用户组ID以检索有关此用户组的信息。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

更新用户组

要更新现有用户组的名称和角色,请使用 put {baseURL}/v3/usergroups/{id} endpoint。

参数

  • workflowCredentialType (string):必填。输入用户组ID以更新此用户组。

  • 合同 (主体):必填。要更新用户组,需要使用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: BearerTokenGoesHere'\--data-urlencode 'name=Marketing'\--data-urlencode 'Role=Artisan'

从用户组中移除用户

要从用户组中删除特定用户,请使用 delete {baseURL}/v3/usergroups//users/{userGroupId}{userId} endpoint。

注意

如果用户不是组的一部分,则将返回"确定"响应。

参数

  • workflowCredentialType (string):必填。输入要从中删除用户的用户组的标识。

  • workflowCredentialType (string):必填。输入要从用户组中删除的用户ID。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

删除用户组

要从系统中删除特定用户组,请使用 delete {baseURL}/v3/usergroups/{id} 终结点。

注意

如果用户组不为空且forceDelete查询参数为false,则返回"400 bad request"错误消息。

参数

  • workflowCredentialType (string):必填。输入要删除的用户组ID。

  • hasPrivateDataExemption  (boolean):可选。如果设置为true,则即使该用户组包含用户,该用户组也将被删除。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

对象关系

如果您要上传工作流,则可以按如下方式使用创建的对象:

创建的对象:“ workflowId ”(例如,“id”: “7917969784f84bd09442f66996ecb8f3”)

您可以将其用作:

Postman 请求示例

POST /v3/usergroups

Example of a POST request in Postman.

删除/v3/usergroups//Users/{userGroupId}{userId}

Example of a DELETE request in Postman.

如需详细了解有关 Postman 请求的更多信息,请访问 如何使用 Postman 帮助页面。