Querying the Login Information of an IAM User

Function

This API is used to query 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:showLoginProfileV5	Read	user *	g:ResourceTag/<tag-key> iam:ResourceIsRootUser	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	Definition: IAM user ID. Constraints: The user ID must exist and be valid. Range: 32 bits. Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

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

**Table 3** login_profile
Parameter	Type	Description
user_id	String	Definition: IAM user ID, which is globally unique. Range: N/A
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. Range: N/A
created_at	String	Definition: Time when the IAM user login information is created. Range: N/A

Status code: 403

**Table 4** 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 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

Example Requests

Querying the login information of a specified IAM user

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

Example Responses

Status code: 200

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