用户管理接口

更新时间：2024-02-01

创建用户

接口描述

创建用户。

请求结构

POST /v1/user HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
name	String	RequestBody参数	用户名	是
description	String	RequestBody参数	用户的描述	否

响应头域

除公共头域外，无其它特殊头域。

响应参数

UserModel对象

请求示例

  POST /v1/user HTTP/1.1
  Host: iam.bj.baidubce.com
  content-type: application/json
  Content-Length: 20
  Authorization: AuthorizationString
  
  {"name":"test-user"}

响应示例

	HTTP/1.1 201 Created     
  Content-Type: application/json;charset=UTF-8     
  X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
  Server: BWS           
 {
     "id": "f4225c39ba2247b692eec7b461835aa1",
     "createTime": "2019-06-06T03:42:13Z",
     "name": "test-user"
 }

查询用户

接口描述

查询用户。

请求结构

  GET /v1/user/{userName} HTTP/1.1
  Host: iam.bj.baidubce.com
  Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

UserModel对象

请求示例

GET /v1/user/test-user 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": "f4225c39ba2247b692eec7b461835aa1",
     "createTime": "2019-06-06T03:42:13Z",
     "name": "test-user"
 }

更新用户

接口描述

更新用户。

请求结构

 PUT /v1/user/{userName} HTTP/1.1
 Host: iam.bj.baidubce.com
 Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是
name	String	RequestBody参数	更新后的用户名	否
description	String	RequestBody参数	用户的描述	否

响应头域

除公共头域外，无其它特殊头域。

响应参数

UserModel对象

请求示例

 PUT /v1/user/test-user HTTP/1.1
 Host: iam.bj.baidubce.com
 content-type: application/json
 Content-Length: 34
 Authorization: AuthorizationString
 
 {"description":"update user demo"}

响应示例

HTTP/1.1 200 OK     
 Content-Type: application/json;charset=UTF-8     
 X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
 Server: BWS     
      
 {
     "id": "f4225c39ba2247b692eec7b461835aa1",
     "createTime": "2019-06-06T03:42:13Z",
     "name": "test-user"
 }

删除用户

接口描述

删除用户。

说明：删除子用户前用户需要解除子用户关联的其他所有对象，包括：权限策略、用户组、AccessKey。

请求结构

DELETE /v1/user/{userName} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

user对象

请求示例

DELETE /v1/user/test-user 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/user HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

无。 响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
users	List<UserModel>	用户对象的列表

请求示例

GET /v1/user 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

{
    "users": [
        {
            "id": "f4225c39ba2247b692eec7b461835aa1",
            "createTime": "2019-06-06T03:42:13Z",
            "name": "test-user"
        }
    ]
}

配置用户的控制台登录

接口描述

配置用户的控制台登录，为其配置登录密码、开启登录MFA、配置第三方账号绑定等。

请求结构

PUT /v1/user/{userName}/loginProfile HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是
loginProfile	LoginProfile	RequestBody参数	控制台登录的相关配置	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

LoginProfile对象

请求示例

PUT /v1/user/test-user/loginProfile HTTP/1.1
Host: iam.bj.baidubce.com
content-type: application/json
Content-Length: 76
Authorization: AuthorizationString

{"password":"Pa$$word4Demo", "enabledLoginMfa":true, "loginMfaType":"PHONE"，
"thirdPartyType":"PASSPORT", "thirdPartyAccount":"test-passportAccount"}

注意：若设置enabledLoginMfa":true, 那么必须要指定loginMfaType。

响应示例

HTTP/1.1 200 OK     
Content-Type: application/json;charset=UTF-8     
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
Server: BWS     

{
    "enabledLogin": true,
    "enabledLoginMfa": true,
    "loginMfaType": "PHONE"，
    "thirdPartyType":"PASSPORT",
    "thirdPartyAccount":"test-passportAccount"
}

查询控制台登录配置

接口描述

查询用户的控制台登录配置。

请求结构

GET /v1/user/{userName}/loginProfile HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

LoginProfile对象

请求示例

GET /v1/user/test-user/loginProfile 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     

{
    "enabledLogin": true,
    "enabledLoginMfa": true,
    "loginMfaType": "PHONE",
    "thirdPartyType":"PASSPORT",
    "thirdPartyAccount":"test-passportAccount"
}

关闭控制台登录配置

接口描述

关闭用户的控制台登录配置，即关闭用户的控制台登录。

请求结构

DELETE /v1/user/{userName}/loginProfile HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

无。

请求示例

DELETE /v1/user/test-user/loginProfile HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK     
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
Server: BWS

修改子用户操作保护

接口描述

修改子用户操作保护，即开启关闭子用户操作保护。

请求结构

POST /v1/user/operation/mfa/switch HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	RequestBody参数	需要更新的子用户名称	是
enabledMfa	Boolean	RequestBody参数	开启或关闭子用户操作保护	是
mfaType	String	RequestBody参数	子用户操作保护类型	否

响应头域

除公共头域外，无其它特殊头域。

响应参数

无。

请求示例

POST /v1/user/operation/mfa/switch HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString
{"userName":"test-username", "enabledMfa":true, "mfaType":"PHONE,TOTP"}

注意：若设置"enabledMfa":true, 那么必须要指定mfaType。

响应示例

HTTP/1.1 200 OK     
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
Server: BWS

修改子用户密码

接口描述

修改子用户密码，不更新当前子用户登录控制台配置。

请求结构

PUT /v1/subUser/{userName}/update HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是
password	String	RequestBody参数	更新后的密码	否

响应头域

除公共头域外，无其它特殊头域。

响应参数

UserModel对象

请求示例

PUT /v1/subUser/test-username/update HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString
{
    "password": "passwordDemo@$$"
}

响应示例

HTTP/1.1 200 OK     
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
Server: BWS     

{
    "id": "f4225c39ba2247b692eec7b461835aa1",
    "name": test-username,
    "createTime": "2023-02-19T03:42:13Z",
    "enable":"true",
    "description":"test update sub user password"
}

创建用户的AccessKey

接口描述

为用户创建一组AccessKey访问密钥。

请求结构

POST /v1/user/{userName}/accesskey HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

AccessKey对象

请求示例

POST /v1/user/test-user/accesskey HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: AuthorizationString

响应示例

HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8     
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
Server: BWS     

{
    "secret": "0f005450fd4e4b329050edc5955da477",
    "id": "e767c68b72194dba9ed71883c7b284b3",
    "createTime": "2019-06-06T07:33:51Z"
}

禁用用户的AccessKey

接口描述

将用户的指定一组AccessKey访问密钥设置为禁用状态。

请求结构

PUT /user/{userName}/accesskey/{accessKeyId}?disable HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是
accessKeyId	String	URL参数	访问密钥id	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

AccessKey对象

请求示例

PUT /v1/user/test-user/accesskey/e767c68b72194dba9ed71883c7b284b3?disable 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
{
    "enabled": false,
    "id": "e767c68b72194dba9ed71883c7b284b3",
    "createTime": "2019-06-06T07:33:51Z"
}

启用用户的AccessKey

接口描述

将用户的指定一组AccessKey访问密钥恢复为启用状态。

请求结构

PUT /user/{userName}/accesskey/{accessKeyId}?enable HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是
accessKeyId	String	URL参数	访问密钥id	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

AccessKey对象

请求示例

PUT /v1/user/test-user/accesskey/e767c68b72194dba9ed71883c7b284b3?enable 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
{
    "enabled": true,
    "id": "e767c68b72194dba9ed71883c7b284b3",
    "createTime": "2019-06-06T07:33:51Z"
}

删除用户的AccessKey

接口描述

删除用户的指定一组AccessKey访问密钥。

请求结构

DELETE /user/{userName}/accesskey/{accessKeyId} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是
accessKeyId	String	URL参数	访问密钥id	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

无

请求示例

DELETE /v1/user/test-user/accesskey/e767c68b72194dba9ed71883c7b284b3 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

列举用户的AccessKey

接口描述

列举用户的全部AccessKey访问密钥。

请求结构

GET /v1/user/{userName}/accesskey HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
accessKeys	List<AccessKey>	用户访问密钥列表

请求示例

GET /v1/user/test-user/accesskey HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK     
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7     
Server: BWS     

{
    "accessKeys": [
        {
            "id": "e0eedb7fc40c45a597c4c80516a918bd",
            "createTime": "2019-06-06T07:37:21Z",
            "lastUsedTime": "2021-10-14T07:37:21Z",
            "enabled": true,
            "description": "测试"
        }
    ]
}

解绑子用户虚拟 MFA

接口描述

解绑子用户虚拟 MFA

请求结构

DELETE /v1/user/{userName}/mfaType/{mfaType} HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
userName	String	URL参数	用户名	是
mfaType	String	URL参数	MFA 类型, 固定为 TOTP	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

无

请求示例

DELETE /v1/user/test2/mfaType/TOTP 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

查询IAM用户联合信息

接口描述

查询IAM用户联合信息，对应页面菜单：多用户访问控制->外部账号接入->IAM用户联合页面的内容。

请求结构

GET /v1/subUser/idp/query HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

无

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
idp	Idp	当前账户IAM用户联合配置

请求示例

GET /v1/subUser/idp/query HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK 
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS

{
    "status": "enable",
    "auxiliaryDomain": "www.baidu.com",
    "domainId": "91b4ee8f04f84c7dae51bc159c9cabcd",
    "encodeMetadata": "xxx",
    "fileName": "xxx.xml",
    "createTime": "2024-01-30T11:57:11.000Z",
    "updateTime": "2024-01-30T11:57:11.000Z"
}

更新IAM用户联合功能状态

接口描述

更新IAM用户联合功能状态。

请求结构

POST /v1/subUser/idp/updateStatus HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

名称	类型	位置	描述	是否必须
status	String	RequestParam参数	功能状态，打开为enable，关闭为disable	是

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
idp	Idp	更新后的当前账户IAM用户联合配置

请求示例

POST /v1/subUser/idp/updateStatus?status=enable HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK 
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS

{
    "status": "enable",
    "auxiliaryDomain": "www.baidu.com",
    "domainId": "91b4ee8f04f84c7dae51bc159c9cabcd",
    "encodeMetadata": "xxx",
    "fileName": "xxx.xml",
    "createTime": "2024-01-30T11:57:11.000Z",
    "updateTime": "2024-01-30T11:57:11.000Z"
}

更新IAM用户联合功能配置

接口描述

更新IAM用户联合功能配置。

请求结构

POST /v1/subUser/idp/update HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求参数

名称	类型	位置	描述	是否必须
updateSubUserIdpRequest	UpdateSubUserIdpRequest	RequestBody参数	更新IAM用户联合功能配置请求体	是

请求头域

除公共头域外，无其它特殊头域。

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
idp	Idp	更新后的当前账户IAM用户联合配置

请求示例

POST /v1/subUser/idp/update HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK 
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS

{
    "status": "enable",
    "auxiliaryDomain": "www.baidu.com",
    "domainId": "91b4ee8f04f84c7dae51bc159c9cabcd",
    "encodeMetadata": "xxx",
    "fileName": "xxx.xml",
    "createTime": "2024-01-30T11:57:11.000Z",
    "updateTime": "2024-01-30T11:57:11.000Z"
}

删除IAM用户联合配置

接口描述

删除IAM用户联合功能配置。

请求结构

POST /v1/subUser/idp/delete HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

无

响应头域

除公共头域外，无其它特殊头域。

响应参数

无

请求示例

POST /v1/subUser/idp/delete HTTP/1.1
Host: iam.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK 
X-Bce-Request-Id: 8d51a788-e79d-4ced-a9e0-0662ec85b7f7
Server: BWS

错误码

组管理接口