管理员修改IAM用户信息(包含邮箱和手机号码)
功能介绍
该接口可以用于修改IAM用户信息,使用对象:管理员 。
URI
PUT /v3.0/OS-USER/users/{user_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
user_id |
是 |
String |
待修改信息的IAM用户ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
该字段内容填为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
拥有Security Administrator权限的token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
是 |
Object |
IAM用户信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
新用户名,长度5~32之间,首位不能为数字,特殊字符只能包含“下划线_、中划线-、和空格”。 |
password |
否 |
String |
IAM用户新密码。
|
|
否 |
String |
IAM用户新邮箱,需符合邮箱格式,长度小于等于255字符。 |
areacode |
否 |
String |
国家码。必须与手机号同时存在。 |
phone |
否 |
String |
IAM用户新手机号,纯数字,长度小于等于32位。必须与国家码同时存在。 |
enabled |
否 |
Boolean |
是否启用IAM用户。true为启用,false为停用,默认为true。 |
pwd_status |
否 |
Boolean |
IAM用户首次登录是否需要修改密码。true为需要修改密码,false为不需要修改密码,默认为true。 |
xuser_type |
否 |
String |
IAM用户在外部系统中的类型。长度小于等于64位。xuser_type如果存在,则需要与同一租户中的xaccount_type、xdomain_type校验,须与xuser_id同时存在。
说明:
外部系统指与系统对接的外部企业管理系统,xaccount_type、xaccount_id、xdomain_type、xdomain_id、xuser_type、xuser_id等参数值,无法在系统获取,请咨询企业管理员。 |
xuser_id |
否 |
String |
IAM用户在外部系统中的ID。长度小于等于128位,必须与xuser_type同时存在。
说明:
外部系统指与系统对接的外部企业管理系统,xaccount_type、xaccount_id、xdomain_type、xdomain_id、xuser_type、xuser_id等参数值,无法在系统获取,请咨询企业管理员。 |
access_mode |
否 |
String |
IAM用户访问方式。
|
description |
否 |
String |
IAM用户新描述信息。 |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
Object |
IAM用户信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
pwd_status |
Boolean |
首次登录是否重置密码。 |
xuser_id |
String |
IAM用户在外部系统中的ID。
说明:
外部系统指与系统对接的外部企业管理系统,xaccount_type、xaccount_id、xdomain_type、xdomain_id、xuser_type、xuser_id等参数值,无法在系统获取,请咨询企业管理员。 |
xuser_type |
String |
IAM用户在外部系统中的类型。
说明:
外部系统指与系统对接的外部企业管理系统,xaccount_type、xaccount_id、xdomain_type、xdomain_id、xuser_type、xuser_id等参数值,无法在系统获取,请咨询企业管理员。 |
description |
String |
IAM用户的新描述信息。 |
name |
String |
IAM用户新用户名,长度5~32之间,首位不能为数字,特殊字符只能包含下划线“_”、中划线“-”和空格。 |
phone |
String |
IAM用户新手机号,纯数字,长度小于等于32位。必须与国家码同时存在。 |
domain_id |
String |
IAM用户所属账号ID。 |
enabled |
Boolean |
是否启用IAM用户。true为启用,false为停用,默认为true。 |
pwd_status |
Boolean |
IAM用户首次登录是否需要修改密码。true为需要修改密码,false为不需要修改密码,默认为true。 |
areacode |
String |
国家码。 |
|
String |
IAM用户新邮箱。 |
id |
String |
IAM用户ID。 |
Object |
IAM用户的资源链接信息。 |
|
password_expires_at |
String |
密码过期时间(UTC时间),“null”表示密码不过期。 |
请求示例
PUT https://sample.domain.com/v3.0/OS-USER/users/{user_id}
{ "user": { "email": "IAMEmail@123.com", "areacode": "0086", "phone": "12345678910", "enabled": true, "name": "IAMUser", "password": "IAMPassword@", "pwd_status": false, "xuser_type": "", "xuser_id": "", "description": "IAMDescription" } }
响应示例
状态码为 200 时:
请求成功。
{ "user": { "description": "IAMDescription", "areacode": "0086", "enabled": true, "pwd_status": false, "xuser_id": "", "domain_id": "d78cbac186b744899480f25bd0...", "phone": "12345678910", "name": "IAMUser", "links": { "self": "https://sample.domain.com/3.0/OS-USER/users/076934ff9f0010cd1f0bc003..." }, "id": "076934ff9f0010cd1f0bc0031019...", "xuser_type": "", "email": "IAMEmail@123.com" } }
返回值
返回值 |
描述 |
---|---|
200 |
请求成功。 |
400 |
参数无效。 |
401 |
认证失败。 |
403 |
没有操作权限。 |
404 |
未找到相应的资源。 |
405 |
不允许的方法。 |
409 |
资源冲突。 |
413 |
请求体过大。 |
500 |
内部服务错误。 |
503 |
服务不可用。 |
错误码
状态码 |
错误码 |
错误信息 |
---|---|---|
400 |
1100 |
缺失必选参数。 |
400 |
1101 |
用户名校验失败。 |
400 |
1102 |
邮箱校验失败。 |
400 |
1103 |
密码校验失败。 |
400 |
1104 |
手机号校验失败。 |
400 |
1105 |
xuser_type必须与xdomain_type相同。 |
400 |
1106 |
国家码、手机号必须同时存在。 |
400 |
1107 |
账号管理员不能被删除。 |
400 |
1108 |
新密码不能与原密码相同。 |
400 |
1109 |
用户名已存在。 |
400 |
1110 |
邮箱已存在。 |
400 |
1111 |
手机号已存在。 |
400 |
1113 |
xuser_id、xuser_type已存在。 |
400 |
1115 |
IAM用户数量达到最大限制。 |
400 |
1117 |
用户描述校验失败。 |