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 root user 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> iam:ResourceIsRootUser	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	Definition IAM user ID, which is globally unique. For details about how to obtain the user ID, see the API for listing IAM users or check the IAM user details page on the IAM console. Constraints The user ID must exist and be valid. Range The value contains 32 characters, including only letters and digits. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
password	Yes	String	Definition IAM user password. Constraints N/A Range The value contains 8 to 32 characters. It must contain at least two types of the following characters: uppercase letters, lowercase letters, digits, and special characters. Default Value N/A
password_reset_required	Yes	Boolean	Definition: Whether the IAM user needs to change the password upon the next login. Constraints: N/A Range: The value can be true or false. Default Value: N/A

Response Parameters

Status code: 201

**Table 3** Response body parameters
Parameter	Type	Description
login_profile	login_profile object	Definition: IAM user login information. Range: N/A

**Table 4** login_profile
Parameter	Type	Description
user_id	String	Definition IAM user ID, which is globally unique. For details about how to obtain the user ID, see the API for listing IAM users or check the IAM user details page on the IAM console. Range The value contains 32 characters, including only letters and digits.
password_reset_required	Boolean	Definition: Whether the IAM user needs to change the password upon the next login. Range: The value can be true or false.
password_expires_at	String	Definition Time when the password of an IAM user expires. The UTC time format is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-13T06:51:20.550Z. Range N/A
created_at	String	Definition Time when the IAM user login information was created. The UTC time format is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-13T06:51:20.550Z. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A
encoded_authorization_message	String	Definition: Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

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