Show Menu
主题×

组管理 API 方法

其余 API 管理组的方法,包括创建、更新、列出和删除组。

创建群组

POST 于创建新用户组的方法。

请求

POST /api/v1/groups/

示例请求主体

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

响应

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

更新组

PUT 于更新用户组的方法。

请求

PUT /api/v1/groups/ <groupId>

示例请求主体

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

响应

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

列表组

一种 GET 列表用户组的方法。

请求

GET /api/v1/groups/

响应

[
  { 
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }, ...
]

删除群组

一种 DELETE 删除用户组并从该用户组中删除所有成员的方法。

请求

DELETE /api/v1/groups/ <groupId>
成功 204 No Content 时返回。 如果冲突再次发生 409 Conflict

批量删除组

一种 DELETE 批量删除多个组并从该组中删除所有成员的方法。

请求

DELETE /api/v1/groups/bulk-delete
成功 204 No Content 时返回。 如果冲突再次发生 409 Conflict

列表组的所有权限

列表 GET 组上权限对象的方法。

请求

GET /api/v1/groups/{groupId}/permissions

响应

[{
 "objectId" : 34,
 "objectType": "SEGMENT",
 "permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
 },

{
 "objectId" : "234",
 "objectType": "TRAIT",
 "permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
 },
 {
 "objectId" : 277,
 "objectType": "SEGMENT",
 "permissions": ["READ", "WRITE", "MAP_TO_MODELS"]
 }
]

返回 400 Bad Request 组(如果组无法访问)。

Set Permissions for a Group

用于 PUT 更新组权限的方法。 此方法用新权限覆盖旧权限。

请求

PUT /api/v1/groups/{groupId}/permissions/

响应

[ 
  { "objectType" : "SEGMENT",
    "objectId" : 563,
    "permissions" : [ "READ", "WRITE"]
  },
  { "objectType" : "SEGMENT",
    "objectId" : 2363,
    "permissions" : [ "CREATE", "WRITE"]
  },
  { "objectType" : "TRAIT",
    "objectId" : 83498,
    "permissions" : [ "READ", "MAP_TO_SEGMENTS"]
  },
  { "objectType" : "DESTINATION",
    "objectId" : 304,
    "permissions" : [ "READ", "WRITE", "CREATE"]
  }
]

示例响应表示权限对象的更新列表。
成功 200 OK 时返回。 如果 400 任何给定权限无效,则返回。 如果已登 403 录用户无法访问该对象,也可以返回。