修改账号密码策略 - UpdatePasswordPolicyV5
功能介绍
该接口可以用于修改账号密码策略。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| iam:securitypolicies:updatePasswordPolicyV5 | Write | - | - | - | - |
URI
PUT /v5/password-policy
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| maximum_consecutive_identical_chars | 否 | Integer | 参数解释: 同一字符连续出现的最大次数。 约束限制: 不涉及。 取值范围: 取值范围为[0,32]。 默认取值: 不涉及。 |
| minimum_password_age | 否 | Integer | 参数解释: 密码最短使用时间(分钟)。 约束限制: 不涉及。 取值范围: 取值范围为[0,1440]。 默认取值: 不涉及。 |
| minimum_password_length | 否 | Integer | 参数解释: 密码最小字符数。 约束限制: 不涉及。 取值范围: 取值范围为[8,32]。 默认取值: 不涉及。 |
| password_reuse_prevention | 否 | Integer | 参数解释: 密码不能与历史密码重复次数。 约束限制: 不涉及。 取值范围: 取值范围为[0,24]。 默认取值: 不涉及。 |
| password_not_username_or_invert | 否 | Boolean | 参数解释: 密码是否可以是用户名或用户名的反序。 约束限制: 不涉及。 取值范围: 取值范围为true或false。 默认取值: 默认值为true,为true时表示密码不可以是用户名或用户名的反序。 |
| password_validity_period | 否 | Integer | 参数解释: 密码有效期(天)。 约束限制: 不涉及。 取值范围: 取值范围为[0,180]。 默认取值: 不涉及。 |
| password_char_combination | 否 | Integer | 参数解释: 至少包含字符种类的个数。 约束限制: 不涉及。 取值范围: 取值范围为[2,4]。 默认取值: 不涉及。 |
| allow_user_to_change_password | 否 | Boolean | 参数解释: 是否允许IAM用户修改自己的密码。 约束限制: 不适用于根用户。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| password_policy | password_policy object | 参数解释: 密码策略。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| maximum_consecutive_identical_chars | Integer | 参数解释: 同一字符连续出现的最大次数。 取值范围: 不涉及。 |
| maximum_password_length | Integer | 参数解释: 密码最大字符数。 取值范围: 不涉及。 |
| minimum_password_age | Integer | 参数解释: 密码最短使用时间(分钟)。 取值范围: 不涉及。 |
| minimum_password_length | Integer | 参数解释: 密码最小字符数。 取值范围: 不涉及。 |
| password_reuse_prevention | Integer | 参数解释: 密码不能与历史密码重复次数。 取值范围: 不涉及。 |
| password_not_username_or_invert | Boolean | 参数解释: 密码是否可以是用户名或用户名的反序。默认值为true,为true时表示密码不可以是用户名或用户名的反序。 取值范围: 不涉及。 |
| password_requirements | String | 参数解释: 设置密码必须包含的字符要求。 取值范围: 不涉及。 |
| password_validity_period | Integer | 参数解释: 密码有效期(天)。 取值范围: 不涉及。 |
| password_char_combination | Integer | 参数解释: 至少包含字符种类的个数。 取值范围: 不涉及。 |
| allow_user_to_change_password | Boolean | 参数解释: 是否允许IAM用户修改自己的密码,不适用于根用户。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如 PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API 请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误消息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。 取值范围: 不涉及。 |
请求示例
修改账号密码策略。
PUT https://{endpoint}/v5/password-policy
{
"maximum_consecutive_identical_chars" : 0,
"minimum_password_age" : 0,
"minimum_password_length" : 8,
"password_reuse_prevention" : 1,
"password_validity_period" : 180,
"password_char_combination" : 2,
"allow_user_to_change_password" : true
} 响应示例
状态码:200
请求成功。
{
"password_policy" : {
"maximum_consecutive_identical_chars" : 0,
"maximum_password_length" : 32,
"minimum_password_age" : 0,
"minimum_password_length" : 8,
"password_reuse_prevention" : 1,
"password_not_username_or_invert" : true,
"password_requirements" : "A password must contain at least two of the following: uppercase letters, lowercase letters, digits, and special characters.",
"password_validity_period" : 180,
"password_char_combination" : 2,
"allow_user_to_change_password" : true
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求体异常。 |
| 403 | 没有操作权限。 |
错误码
请参见错误码。