用户管理接口
创建用户
接口描述
创建用户。
请求结构
1POST /v1/user HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
name | String | RequestBody参数 | 用户名 | 是 |
description | String | RequestBody参数 | 用户的描述 | 否 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1 POST /v1/user HTTP/1.1
2 Host: iam.bj.baidubce.com
3 content-type: application/json
4 Content-Length: 20
5 Authorization: AuthorizationString
6
7 {"name":"test-user"}
响应示例
1 HTTP/1.1 201 Created
2 Content-Type: application/json;charset=UTF-8
3 X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4 Server: BWS
5 {
6 "id": "f4225c39ba2247b692eec7b461835aa1",
7 "createTime": "2019-06-06T03:42:13Z",
8 "name": "test-user"
9 }
查询用户
接口描述
查询用户。
请求结构
1 GET /v1/user/{userName} HTTP/1.1
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1GET /v1/user/test-user HTTP/1.1
2Host: iam.bj.baidubce.com
3content-type: application/json
4Authorization: AuthorizationString
响应示例
1HTTP/1.1 200 OK
2 Content-Type: application/json;charset=UTF-8
3 X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4 Server: BWS
5
6 {
7 "id": "f4225c39ba2247b692eec7b461835aa1",
8 "createTime": "2019-06-06T03:42:13Z",
9 "name": "test-user"
10 }
11
更新用户
接口描述
更新用户。
请求结构
1 PUT /v1/user/{userName} HTTP/1.1
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
name | String | RequestBody参数 | 更新后的用户名 | 否 |
description | String | RequestBody参数 | 用户的描述 | 否 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1 PUT /v1/user/test-user HTTP/1.1
2 Host: iam.bj.baidubce.com
3 content-type: application/json
4 Content-Length: 34
5 Authorization: AuthorizationString
6
7 {"description":"update user demo"}
响应示例
1HTTP/1.1 200 OK
2 Content-Type: application/json;charset=UTF-8
3 X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4 Server: BWS
5
6 {
7 "id": "f4225c39ba2247b692eec7b461835aa1",
8 "createTime": "2019-06-06T03:42:13Z",
9 "name": "test-user"
10 }
删除用户
接口描述
删除用户。
说明:删除子用户前用户需要解除子用户关联的其他所有对象,包括:权限策略、用户组、AccessKey。
请求结构
1DELETE /v1/user/{userName} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
user对象
请求示例
1DELETE /v1/user/test-user HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 204 No Content
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
列举用户
接口描述
列举用户。
请求结构
1GET /v1/user HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
无。 响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
users | List<UserModel> | 用户对象的列表 |
请求示例
1GET /v1/user HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5
6{
7 "users": [
8 {
9 "id": "f4225c39ba2247b692eec7b461835aa1",
10 "createTime": "2019-06-06T03:42:13Z",
11 "name": "test-user"
12 }
13 ]
14}
配置用户的控制台登录
接口描述
配置用户的控制台登录,为其配置登录密码、开启登录MFA、配置第三方账号绑定等。
请求结构
1PUT /v1/user/{userName}/loginProfile HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
loginProfile | LoginProfile | RequestBody参数 | 控制台登录的相关配置 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1PUT /v1/user/test-user/loginProfile HTTP/1.1
2Host: iam.bj.baidubce.com
3content-type: application/json
4Content-Length: 76
5Authorization: AuthorizationString
6
7{"password":"Pa$$word4Demo", "enabledLoginMfa":true, "loginMfaType":"PHONE",
8"thirdPartyType":"PASSPORT", "thirdPartyAccount":"test-passportAccount"}
注意:若设置
enabledLoginMfa":true
, 那么必须要指定loginMfaType
。
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5
6{
7 "enabledLogin": true,
8 "enabledLoginMfa": true,
9 "loginMfaType": "PHONE",
10 "thirdPartyType":"PASSPORT",
11 "thirdPartyAccount":"test-passportAccount"
12}
查询控制台登录配置
接口描述
查询用户的控制台登录配置。
请求结构
1GET /v1/user/{userName}/loginProfile HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1GET /v1/user/test-user/loginProfile HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5
6{
7 "enabledLogin": true,
8 "enabledLoginMfa": true,
9 "loginMfaType": "PHONE",
10 "thirdPartyType":"PASSPORT",
11 "thirdPartyAccount":"test-passportAccount"
12}
关闭控制台登录配置
接口描述
关闭用户的控制台登录配置,即关闭用户的控制台登录。
请求结构
1DELETE /v1/user/{userName}/loginProfile HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无。
请求示例
1DELETE /v1/user/test-user/loginProfile HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
修改子用户操作保护
接口描述
修改子用户操作保护,即开启关闭子用户操作保护。
请求结构
1POST /v1/user/operation/mfa/switch HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | RequestBody参数 | 需要更新的子用户名称 | 是 |
enabledMfa | Boolean | RequestBody参数 | 开启或关闭子用户操作保护 | 是 |
mfaType | String | RequestBody参数 | 子用户操作保护类型 | 否 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无。
请求示例
1POST /v1/user/operation/mfa/switch HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
4{"userName":"test-username", "enabledMfa":true, "mfaType":"PHONE,TOTP"}
注意:若设置
"enabledMfa":true
, 那么必须要指定mfaType
。
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
修改子用户密码
接口描述
修改子用户密码,不更新当前子用户登录控制台配置。
请求结构
1PUT /v1/subUser/{userName}/update HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
password | String | RequestBody参数 | 更新后的密码 | 否 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1PUT /v1/subUser/test-username/update HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
4{
5 "password": "passwordDemo@$$"
6}
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
4
5{
6 "id": "f4225c39ba2247b692eec7b461835aa1",
7 "name": test-username,
8 "createTime": "2023-02-19T03:42:13Z",
9 "enable":"true",
10 "description":"test update sub user password"
11}
创建用户的AccessKey
接口描述
为用户创建一组AccessKey访问密钥。
请求结构
1POST /v1/user/{userName}/accesskey HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1POST /v1/user/test-user/accesskey HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 201 Created
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5
6{
7 "secret": "0f005450fd4e4b329050edc5955da477",
8 "id": "e767c68b72194dba9ed71883c7b284b3",
9 "createTime": "2019-06-06T07:33:51Z"
10}
禁用用户的AccessKey
接口描述
将用户的指定一组AccessKey访问密钥设置为禁用状态。
请求结构
1PUT /user/{userName}/accesskey/{accessKeyId}?disable HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
accessKeyId | String | URL参数 | 访问密钥id | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1PUT /v1/user/test-user/accesskey/e767c68b72194dba9ed71883c7b284b3?disable HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5{
6 "enabled": false,
7 "id": "e767c68b72194dba9ed71883c7b284b3",
8 "createTime": "2019-06-06T07:33:51Z"
9}
启用用户的AccessKey
接口描述
将用户的指定一组AccessKey访问密钥恢复为启用状态。
请求结构
1PUT /user/{userName}/accesskey/{accessKeyId}?enable HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
accessKeyId | String | URL参数 | 访问密钥id | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
请求示例
1PUT /v1/user/test-user/accesskey/e767c68b72194dba9ed71883c7b284b3?enable HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5{
6 "enabled": true,
7 "id": "e767c68b72194dba9ed71883c7b284b3",
8 "createTime": "2019-06-06T07:33:51Z"
9}
删除用户的AccessKey
接口描述
删除用户的指定一组AccessKey访问密钥。
请求结构
1DELETE /user/{userName}/accesskey/{accessKeyId} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
accessKeyId | String | URL参数 | 访问密钥id | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无
请求示例
1DELETE /v1/user/test-user/accesskey/e767c68b72194dba9ed71883c7b284b3 HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 204 No Content
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
列举用户的AccessKey
接口描述
列举用户的全部AccessKey访问密钥。
请求结构
1GET /v1/user/{userName}/accesskey HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
accessKeys | List<AccessKey> | 用户访问密钥列表 |
请求示例
1GET /v1/user/test-user/accesskey HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
4
5{
6 "accessKeys": [
7 {
8 "id": "e0eedb7fc40c45a597c4c80516a918bd",
9 "createTime": "2019-06-06T07:37:21Z",
10 "lastUsedTime": "2021-10-14T07:37:21Z",
11 "enabled": true,
12 "description": "测试"
13 }
14 ]
15}
查询用户的AccessKey上次使用时间
接口描述
查询用户提供的AccessKey访问密钥上次使用时间。
说明:拥有系统策略:IAMManageAccessKeyPolicy 权限的子用户可以查看自身AccessKey的上次使用时间;拥有系统策略:IAMFullControlAccessPolicy 、IAMReadAccessPolicy 权限的子用户可以查看所在账号下所有子用户AccessKey的上次使用时间
请求结构
1GET /v1/accesskey/{accessKeyId}/lastusedtime HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
accessKeyId | String | URL参数 | 访问密钥id | 是 |
响应参数
名称 | 类型 | 描述 |
---|---|---|
accessKeyId | String | 访问密钥id |
lastUsedTime | String | 访问密钥id的上次使用时间 |
请求示例
1GET /v1/accesskey/e767c68b72194dba9ed71883c7b284b3/lastusedtime HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
响应示例
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
4Server: BWS
5
6{
7 "accessKeyId": "e767c68b72194dba9ed71883c7b284b3",
8 "lastUsedTime": "2024-10-25T08:27:43.000Z"
9}
解绑子用户虚拟 MFA
接口描述
解绑子用户虚拟 MFA
请求结构
1DELETE /v1/user/{userName}/mfaType/{mfaType} HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
userName | String | URL参数 | 用户名 | 是 |
mfaType | String | URL参数 | MFA 类型, 固定为 TOTP | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
无
请求示例
1DELETE /v1/user/test2/mfaType/TOTP HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: AuthorizationString
响应示例
1HTTP/1.1 204 No Content
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
查询IAM用户联合信息
接口描述
查询IAM用户联合信息,对应页面菜单:多用户访问控制->外部账号接入->IAM用户联合页面的内容。
请求结构
1GET /v1/subUser/idp/query HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
无
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
idp | Idp | 当前账户IAM用户联合配置 |
请求示例
1GET /v1/subUser/idp/query HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
4
5{
6 "status": "enable",
7 "auxiliaryDomain": "www.baidu.com",
8 "domainId": "91b4ee8f04f84c7dae51bc159c9cabcd",
9 "encodeMetadata": "xxx",
10 "fileName": "xxx.xml",
11 "createTime": "2024-01-30T11:57:11.000Z",
12 "updateTime": "2024-01-30T11:57:11.000Z"
13}
更新IAM用户联合功能状态
接口描述
更新IAM用户联合功能状态。
请求结构
1POST /v1/subUser/idp/updateStatus HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
status | String | RequestParam参数 | 功能状态,打开为enable,关闭为disable | 是 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
idp | Idp | 更新后的当前账户IAM用户联合配置 |
请求示例
1POST /v1/subUser/idp/updateStatus?status=enable HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
4
5{
6 "status": "enable",
7 "auxiliaryDomain": "www.baidu.com",
8 "domainId": "91b4ee8f04f84c7dae51bc159c9cabcd",
9 "encodeMetadata": "xxx",
10 "fileName": "xxx.xml",
11 "createTime": "2024-01-30T11:57:11.000Z",
12 "updateTime": "2024-01-30T11:57:11.000Z"
13}
更新IAM用户联合功能配置
接口描述
更新IAM用户联合功能配置。
请求结构
1POST /v1/subUser/idp/update HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
updateSubUserIdpRequest | UpdateSubUserIdpRequest | RequestBody参数 | 更新IAM用户联合功能配置请求体 | 是 |
请求头域
除公共头域外,无其它特殊头域。
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
idp | Idp | 更新后的当前账户IAM用户联合配置 |
请求示例
1POST /v1/subUser/idp/update HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS
4
5{
6 "status": "enable",
7 "auxiliaryDomain": "www.baidu.com",
8 "domainId": "91b4ee8f04f84c7dae51bc159c9cabcd",
9 "encodeMetadata": "xxx",
10 "fileName": "xxx.xml",
11 "createTime": "2024-01-30T11:57:11.000Z",
12 "updateTime": "2024-01-30T11:57:11.000Z"
13}
删除IAM用户联合配置
接口描述
删除IAM用户联合功能配置。
请求结构
1POST /v1/subUser/idp/delete HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
无
响应头域
除公共头域外,无其它特殊头域。
响应参数
无
请求示例
1POST /v1/subUser/idp/delete HTTP/1.1
2Host: iam.bj.baidubce.com
3Authorization: authorization string
响应示例
1HTTP/1.1 200 OK
2X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
3Server: BWS