创建IAM用户登录信息 - CreateLoginProfileV5

功能介绍

该接口可以用于创建指定IAM用户的登录信息。

调试

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

授权信息

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

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
iam:users:createLoginProfileV5	Write	user *	g:ResourceTag/<tag-key>	-	-

URI

POST /v5/users/{user_id}/login-profile

表1 路径参数
参数	是否必选	参数类型	描述
user_id	是	String	参数解释： IAM用户ID。约束限制：用户ID需要真实存在且有效。取值范围： 32位。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
password	是	String	参数解释： IAM用户的密码。约束限制：长度为8到32位。取值范围：不涉及。默认取值：不涉及。
password_reset_required	是	Boolean	参数解释： IAM用户下次登录时是否需要修改密码。约束限制：不涉及。取值范围：取值范围为[true,false]。默认取值：不涉及。

响应参数

状态码：201

表3 响应Body参数
参数	参数类型	描述
login_profile	login_profile object	参数解释： IAM用户登录信息。取值范围：不涉及。

表4 login_profile
参数	参数类型	描述
user_id	String	参数解释： IAM用户ID，是IAM用户的全局唯一标识。取值范围：不涉及。
password_reset_required	Boolean	参数解释： IAM用户下次登录时是否需要修改密码。取值范围：取值范围为[true,false]。
password_expires_at	String	参数解释： IAM用户密码过期时间。取值范围：不涉及。
created_at	String	参数解释： IAM用户登录信息创建时间。取值范围：不涉及。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

状态码：403

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误消息。取值范围：不涉及。
request_id	String	参数解释： API请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。
encoded_authorization_message	String	参数解释：认证失败时返回的加密详细信息，用于定位认证问题。可以通过STS5解密接口进行解密，请参见接口链接。取值范围：不涉及。

状态码：404

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

状态码：409

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

请求示例

创建指定IAM用户的登录信息，设置其密码为Password0，并要求下次登录时修改密码。

POST https://{endpoint}/v5/users/{user_id}/login-profile

{
  "password" : "Password0",
  "password_reset_required" : true
}

响应示例

状态码：201

请求成功。

{
  "login_profile" : {
    "user_id" : "user",
    "password_reset_required" : true,
    "password_expires_at" : "2023-09-13T08:03:10.781Z",
    "created_at" : "2023-09-13T08:03:10.781Z"
  }
}