j9九游会登录/ 统一身份认证服务 iam_统一身份认证服务（新版）/ api参考/ / / / 修改账号登录策略 - updateloginpolicyv5
更新时间：2025-12-25 gmt 08:00
查看pdf

修改账号登录策略 -j9九游会登录

功能介绍

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

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

授权信息

账号根用户具备所有api的调用权限，如果使用账号下的iam用户调用当前api，该iam用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

iam:securitypolicies:updateloginpolicyv5

write

-

-

-

-

uri

put /v5/login-policy

请求参数

表1 请求body参数

参数

是否必选

参数类型

描述

user_validity_period

否

integer

如果iam用户在该值设置的有效期（天）内未登录，则被停用，不适用于根用户，取值范围为[0,240]。

最小值：0

最大值：240

custom_info_for_login

否

string

登录提示信息，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。

最大长度：64

lockout_duration

否

integer

iam用户登录锁定时长（分钟），取值范围为[15,1440]。

最小值：15

最大值：1440

login_failed_times

否

integer

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

最小值：3

最大值：10

period_with_login_failures

否

integer

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

最小值：15

最大值：60

session_timeout

否

integer

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

最小值：15

最大值：1440

show_recent_login_info

否

boolean

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

allow_address_netmasks

否

array of allowaddressnetmask objects

允许访问的ip地址或网段，例如"xxx.xxx.xxx.xxx/24"。

allow_ip_ranges

否

array of allowiprange objects

允许访问的ip地址区间，取值为ip地址区间，例如"0.0.0.0-255.255.255.255"。
表2 allowaddressnetmask

参数

是否必选

参数类型

描述

address_netmask

是

string

ip地址或网段，例如"192.168.0.1/24"。

最大长度：50

description

否

string

描述信息，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。

最大长度：255
表3 allowiprange

参数

是否必选

参数类型

描述

ip_range

是

string

ip地址区间，例如"0.0.0.0-255.255.255.255"。

最大长度：50

description

否

string

描述信息，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。

最大长度：255

响应参数

状态码：200

表4 响应body参数

参数

参数类型

描述

login_policy

loginpolicy object

登录策略。
表5 loginpolicy

参数

参数类型

描述

user_validity_period

integer

如果iam用户在该值设置的有效期（天）内未登录，则被停用，不适用于根用户。

custom_info_for_login

string

登录提示信息。

lockout_duration

integer

iam用户登录锁定时长（分钟）。

login_failed_times

integer

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

period_with_login_failures

integer

限定时间长度（分钟）。

session_timeout

integer

登录会话失效时间。

show_recent_login_info

boolean

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

allow_address_netmasks

array of allowaddressnetmask objects

允许访问的ip地址或网段。

allow_ip_ranges

array of allowiprange objects

允许访问的ip地址区间。
表6 allowaddressnetmask

参数

参数类型

描述

address_netmask

string

ip地址或网段，例如"192.168.0.1/24"。

最大长度：50

description

string

描述信息，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。

最大长度：255
表7 allowiprange

参数

参数类型

描述

ip_range

string

ip地址区间，例如"0.0.0.0-255.255.255.255"。

最大长度：50

description

string

描述信息，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。

最大长度：255

状态码：400

表8 响应body参数

参数

参数类型

描述

error_code

string

错误码。

error_msg

string

错误信息。

状态码：403

表9 响应body参数

参数

参数类型

描述

error_code

string

错误码。

error_msg

string

错误信息。

request_id

string

请求id。

encoded_authorization_message

string

加密后的认证失败信息，可以通过sts5解密接口进行解密。

请求示例

修改账号登录策略。

put https://{endpoint}/v5/login-policy
{
  "user_validity_period" : 0,
  "custom_info_for_login" : "info",
  "lockout_duration" : 15,
  "login_failed_times" : 5,
  "period_with_login_failures" : 15,
  "session_timeout" : 60,
  "show_recent_login_info" : false,
  "allow_address_netmasks" : [ {
    "address_netmask" : "192.168.0.1/24",
    "description" : "description"
  } ],
  "allow_ip_ranges" : [ {
    "ip_range" : "0.0.0.0-255.255.255.255",
    "description" : "description"
  } ]
}

响应示例

状态码：200

请求成功。

{
  "login_policy" : {
    "user_validity_period" : 0,
    "custom_info_for_login" : "info",
    "lockout_duration" : 15,
    "login_failed_times" : 5,
    "period_with_login_failures" : 15,
    "session_timeout" : 60,
    "show_recent_login_info" : false,
    "allow_address_netmasks" : [ {
      "address_netmask" : "192.168.0.1/24",
      "description" : "description"
    } ],
    "allow_ip_ranges" : [ {
      "ip_range" : "0.0.0.0-255.255.255.255",
      "description" : "description"
    } ]
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

403

没有操作权限。

错误码

请参见错误码。

父主题：

相关文档

网站地图