文档首页/ 统一身份认证服务 IAM/ API参考/ API/ 安全设置/ 修改账号登录策略
更新时间：2024-07-30 GMT+08:00
查看PDF
分享

修改账号登录策略

功能介绍

该接口可以用于管理员修改账号登录策略。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/login-policy

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

访问令牌，承载用户的身份、权限等信息。

token所需权限请参见授权项。
表3 请求Body参数

参数

是否必选

参数类型

描述

login_policy

是

object

登录策略。
表4 login_policy

参数

是否必选

参数类型

描述

account_validity_period

否

Integer

登录停用信息，取值范围[0,240]。

custom_info_for_login

否

String

登录提示信息。

lockout_duration

否

Integer

账号锁定时长（分钟），取值范围[15,30]。

login_failed_times

否

Integer

限定时间内登录失败次数，取值范围[3,10]。

period_with_login_failures

否

Integer

限定时间长度（分钟），取值范围[15,60]。

session_timeout

否

Integer

登录会话失效时间，取值范围[15,1440]。

show_recent_login_info

否

Boolean

显示最近一次的登录信息。取值范围true或false。

响应参数

表5 响应Body参数

参数

参数类型

描述

login_policy

object

登录策略。
表6 login_policy

参数

参数类型

描述

account_validity_period

Integer

账号在该值设置的有效期内未使用，则被停用。

custom_info_for_login

String

登录提示信息。

lockout_duration

Integer

账号锁定时长（分钟）。

login_failed_times

Integer

限定时间内登录失败次数。

period_with_login_failures

Integer

限定时间长度（分钟）。

session_timeout

Integer

登录会话失效时间。

show_recent_login_info

Boolean

是否显示最近一次的登录信息。

请求示例

修改账号的登录策略：登录失败后账号限定时长为15分钟，账号在99天内未使用则被停用，限定时间内登录失败次数为3次，登录会话失效时间为16分钟，显示最近一次的登录信息。

PUT https://iam.myhuaweicloud.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/login-policy 
 
{ 
  "login_policy" : { 
    "custom_info_for_login" : "", 
    "period_with_login_failures" : 15, 
    "lockout_duration" : 15, 
    "account_validity_period" : 99, 
    "login_failed_times" : 3, 
    "session_timeout" : 16, 
    "show_recent_login_info" : true 
  } 
}

响应示例

状态码为 200 时:

请求成功。

{ 
  "login_policy" : { 
    "custom_info_for_login" : "", 
    "period_with_login_failures" : 15, 
    "lockout_duration" : 15, 
    "account_validity_period" : 99, 
    "login_failed_times" : 3, 
    "session_timeout" : 16, 
    "show_recent_login_info" : true 
  } 
}

状态码为 400 时:

请求体异常。

  • 示例 1
{ 
   "error_msg" : "'%(key)s' is a required property.", 
   "error_code" : "IAM.0072" 
 }
  • 示例 2
{ 
   "error_msg" : "Invalid input for field '%(key)s'. The value is '%(value)s'.", 
   "error_code" : "IAM.0073" 
 }

状态码为 403 时:

鉴权失败。

{ 
  "error_msg" : "You are not authorized to perform the requested action.", 
  "error_code" : "IAM.0002" 
}

状态码为 500 时:

系统异常。

{ 
  "error_msg" : "An unexpected error prevented the server from fulfilling your request.", 
  "error_code" : "IAM.0006" 
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

401

认证失败。

403

鉴权失败。

500

系统异常。

错误码

请参见错误码。

父主题： 安全设置