All Products
Search
Document Center

Resource Access Management:GetLoginProfile

Last Updated:Aug 18, 2023

Queries the console logon settings of a RAM user.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ram:GetLoginProfileRead
  • RAM
    acs:ram::{#accountId}:user/{#UserName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserPrincipalNamestringYes

The logon name of the RAM user.

test@example.onaliyun.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

E517F18B-632C-48FC-93F1-CDCBCC6F8444
LoginProfileobject

The logon information.

Statusstring

The status of password-based logon.

Active
UserPrincipalNamestring

The logon name of the RAM user.

test@example.onaliyun.com
UpdateDatestring

The update time.

2020-10-14T06:56:45Z
LastLoginTimestring

The last time when the RAM user logged on to the console.

2020-10-14T07:25:25Z
PasswordResetRequiredboolean

Indicates whether the RAM user must reset the password at the next logon.

false
MFABindRequiredboolean

Indicates whether multi-factor authentication (MFA) must be enabled.

false

Examples

Sample success responses

JSONformat

{
  "RequestId": "E517F18B-632C-48FC-93F1-CDCBCC6F8444",
  "LoginProfile": {
    "Status": "Active",
    "UserPrincipalName": "test@example.onaliyun.com",
    "UpdateDate": "2020-10-14T06:56:45Z",
    "LastLoginTime": "2020-10-14T07:25:25Z",
    "PasswordResetRequired": false,
    "MFABindRequired": false
  }
}

Error codes

For a list of error codes, visit the Service error codes.