角色管理接口
更新时间:2020-01-16
创建角色
接口描述
创建角色。
请求结构
POST /v1/role HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
name | String | RequestBody参数 | 角色名 | 是 |
description | String | RequestBody参数 | 角色的描述 | 否 |
assumeRolePolicyDocument | String | RequestBody参数 | 指定允许扮演角色的载体 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
POST /v1/user HTTP/1.1h
Host: iam.bj.baidubce.com
content-type: application/json
Content-Length: 20
Authorization: Authorization String
{
"name":"test-role",
"description":"test role create",
"assumeRolePolicyDocument": "{\"version\":\"v1\",\"accessControlList\":[{\"service\":\"bce:iam\",\"permission\":[\"AssumeRole\"],\"region\":\"*\",\"grantee\":[{\"id\":\"grantee-id\"}],\"effect\":\"Allow\"}]}"
}
响应示例
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"id": "9c039e6385854e07a5a31e254eab21ea",
"createTime": "2019-06-06T03:42:13Z",
"name": "test-role",
"assumeRolePolicyDocument": "{\"id\":\"sts role acl\",\"version\":\"v1\",\"accessControlList\":[{\"service\":\"bce:iam\",\"region\":\"*\",\"resource\":[\"role/9c039e6385854e07a5a31e254eab21ea\"],\"grantee\":[{\"id\":\"grantee-id\"}],\"effect\":\"Allow\",\"permission\":[\"AssumeRole\"],\"eid\":\"role acl entry\"}]}"
}
查询角色
接口描述
查询角色。
请求结构
GET /v1/role/{roleName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
roleName | String | URL参数 | 角色名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
GET /v1/role/test-role HTTP/1.1
Host: iam.bj.baidubce.com
content-type: application/json
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
{
"id": "9c039e6385854e07a5a31e254eab21ea",
"createTime": "2019-06-06T03:42:13Z",
"name": "test-role",
"assumeRolePolicyDocument": "{\"id\":\"sts role acl\",\"version\":\"v1\",\"accessControlList\":[{\"service\":\"bce:iam\",\"region\":\"*\",\"resource\":[\"role/9c039e6385854e07a5a31e254eab21ea\"],\"grantee\":[{\"id\":\"grantee-id\"}],\"effect\":\"Allow\",\"permission\":[\"AssumeRole\"],\"eid\":\"role acl entry\"}]}"
}
更新角色
接口描述
更新角色。
请求结构
PUT /v1/role/{roleName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
roleName | String | URL参数 | 角色名 | 是 |
name | String | RequestBody参数 | 更新后的角色名 | 否 |
description | String | RequestBody参数 | 角色的描述 | 否 |
assumeRolePolicyDocument | String | RequestBody参数 | 指定可以扮演此角色的身份 | 否 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
PUT /v1/role/test-role HTTP/1.1
Host: iam.bj.baidubce.com
content-type: application/json
Content-Length: 34
Authorization: AuthorizationString
{
"description":"update role demo",
"assumeRolePolicyDocument": "{\"version\":\"v1\",\"accessControlList\":[{\"service\":\"bce:iam\",\"permission\":[\"AssumeRole\"],\"region\":\"*\",\"grantee\":[{\"id\":\"new-grantee-id\"}],\"effect\":\"Allow\"}]}"
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"id": "9c039e6385854e07a5a31e254eab21ea",
"createTime": "2019-06-06T03:42:13Z",
"name": "test-role",
"description": "update role demo",
"assumeRolePolicyDocument": "{\"id\":\"sts role acl\",\"version\":\"v1\",\"accessControlList\":[{\"service\":\"bce:iam\",\"region\":\"*\",\"resource\":[\"role/9c039e6385854e07a5a31e254eab21ea\"],\"grantee\":[{\"id\":\"new-grantee-id\"}],\"effect\":\"Allow\",\"permission\":[\"AssumeRole\"],\"eid\":\"role acl entry\"}]}"
}
删除角色
接口描述
删除角色。
请求结构
DELETE /v1/role/{roleName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
roleName | String | URL参数 | 角色名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无。
请求示例
DELETE /v1/role/test-role HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: Authorization String
响应示例
HTTP/1.1 204 No Content
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
列举角色
接口描述
列举角色。
请求结构
GET /v1/role HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
无
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
roles | List<RoleModel> | 角色对象的列表 |
请求示例
GET /v1/role HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: Authorization String
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS
{
"roles": [
{
"id": "9c039e6385854e07a5a31e254eab21ea",
"createTime": "2019-06-06T03:42:13Z",
"name": "test-role",
“description": "update role demo",
"assumeRolePolicyDocument": "{\"id\":\"sts role acl\",\"version\":\"v1\",\"accessControlList\":[{\"service\":\"bce:iam\",\"region\":\"*\",\"resource\":[\"role/9c039e6385854e07a5a31e254eab21ea\"],\"grantee\":[{\"id\":\"grantee-id\"}],\"effect\":\"Allow\",\"permission\":[\"AssumeRole\"],\"eid\":\"role acl entry\"}]}"
}
]
}