组管理接口
更新时间：2020-04-09
创建组
接口描述
创建组。
请求结构
POST /v1/group HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| name | String | RequestBody参数 | 组名 | 是 |
| description | String | RequestBody参数 | 组的描述 | 否 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
POST /v1/group HTTP/1.1
Host: iam.bj.baidubce.com
content-type: application/json
Content-Length: 20
Authorization: AuthorizationString
{"name":"test_group"}响应示例
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"description": "",
"id": "d3f6fd54fe3643459109ea0675c295a8",
"createTime": "2019-06-06T08:18:34Z",
"name": "test_group"
}查询组
接口描述
查询组。
请求结构
GET /v1/group/{groupName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| groupName | String | URL参数 | 组名 | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
GET /v1/group/test_group HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"description": "",
"id": "d3f6fd54fe3643459109ea0675c295a8",
"createTime": "2019-06-06T08:18:34Z",
"name": "test_group"
}更新组
接口描述
更新组。
请求结构
PUT /v1/group/{groupName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| groupName | String | URL参数 | 组名 | 是 |
| name | String | RequestBody参数 | 更新后的组名 | 否 |
| description | String | RequestBody参数 | 组的描述 | 否 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
请求示例
PUT /v1/group/test_group HTTP/1.1
Host: iam.bj.baidubce.com
content-type: application/json
Content-Length: 39
Authorization: AuthorizationString
{"description":"update for test group"}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"description": "update for test group",
"id": "d3f6fd54fe3643459109ea0675c295a8",
"createTime": "2019-06-06T08:18:34Z",
"name": "test_group"
}删除组
接口描述
删除组。
说明：删除组前需要将子用户从组内全部移除，并解除所有权限策略的关联。
请求结构
DELETE /v1/group/{groupName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| groupName | String | URL参数 | 组名 | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无。
请求示例
DELETE /v1/group/test_group HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString响应示例
HTTP/1.1 204 No Content
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS列举组
接口描述
列举组。
请求结构
GET /v1/group HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
无。
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groups | List<GroupModel> | 组对象的列表 |
请求示例
GET /v1/group HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"groups": [
{
"description": "update for test group",
"id": "d3f6fd54fe3643459109ea0675c295a8",
"createTime": "2019-06-06T08:18:34Z",
"name": "test_group"
}
]
}添加用户到组
接口描述
添加用户到组。
请求结构
PUT /v1/group/{groupName}/user/{userName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userName | String | URL参数 | 用户名 | 是 |
| groupName | String | URL参数 | 组名 | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无。
请求示例
PUT /v1/group/test_group/user/test-user HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString响应示例
HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS从组内移除用户
接口描述
从组内移除用户。
请求结构
DELETE /v1/group/{groupName}/user/{userName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userName | String | URL参数 | 用户名 | 是 |
| groupName | String | URL参数 | 组名 | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
无。
请求示例
DELETE /v1/group/test_group/user/test-user HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString响应示例
HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS列举用户的组
接口描述
列举用户所在的组。
请求结构
GET /v1/user/{userName}/group HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userName | String | URL参数 | 用户名 | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| groups | List<GroupModel> | 组对象的列表 |
请求示例
GET /v1/user/test-user/group HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"groups": [
{
"description": "",
"id": "5cf62eee890146ed8116f6b449268f33",
"name": "test_group"
}
]
}列举组内用户
接口描述
列举组内的用户。
请求结构
GET /v1/group/{groupName}/user HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| groupName | String | URL参数 | 组名 | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| users | List<UserModel> | 用户对象的列表 |
请求示例
GET /v1/group/test_group/user
Host: iam.bj.baidubce.com
Authorization: AuthorizationString响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"users": [
{
"id": "f4225c39ba2247b692eec7b461835aa1",
"createTime": "2019-06-06T03:42:13Z",
"name": "test-user"
}
]
}