Creating the Login Information of an IAM User

Function

This API is used to create the login information of a specified IAM user.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam:users:createLoginProfileV5	Write	user *	g:ResourceTag/<tag-key>	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	IAM user ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
password	Yes	String	IAM user password.
password_reset_required	Yes	Boolean	Indicates whether an IAM user needs to change their password upon the next login.

Response Parameters

Status code: 201

**Table 3** Response body parameters
Parameter	Type	Description
login_profile	LoginProfile object	IAM user login information.

**Table 4** LoginProfile
Parameter	Type	Description
user_id	String	IAM user ID.
password_reset_required	Boolean	Indicates whether an IAM user needs to change their password upon the next login.
password_expires_at	String	Time when the password of an IAM user expires.
created_at	String	Time when the IAM user login information was created.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Requests

Creating the login information of a specified IAM user. The password is set to Password0 and the user is asked to change the password upon the next login.

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

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

Example Responses

Status code: 201

Successful

{
  "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"
  }
}