All Products
Search
Document Center

Resource Access Management:CreateLoginProfile

Last Updated:Mar 03, 2024

Enables logon to the console for a RAM user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:CreateLoginProfileWrite
  • User
    acs:ram::{#accountId}:user/{#UserName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserPrincipalNamestringYes

The logon name of the RAM user.

test@example.onaliyun.com
PasswordstringYes

The password that is used to log on to the console.

The password must meet the complexity requirements.

mypassword
PasswordResetRequiredbooleanNo

Specifies whether the RAM user must reset the password at the next logon. Default value: false. Valid values:

  • true
  • false
false
MFABindRequiredbooleanNo

Specifies whether multi-factor authentication (MFA) must be enabled. Valid values:

  • true: MFA must be enabled. The RAM user must bind an MFA device at the next logon.
  • false: MFA is not enabled. This is the default value.
false
StatusstringNo

The status of password-based logon. Valid values:

  • Active: Password-based logon is enabled. This is the default value.
  • Inactive: Password-based logon is disabled.
Active

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

29CB303C-1F05-43A6-A6BC-EBC5A797F8DB
LoginProfileobject

The logon information.

UserPrincipalNamestring

The logon name of the RAM user.

test@example.onaliyun.com
Statusstring

The status of password-based logon.

Active
UpdateDatestring

The update time.

2020-10-14T03:47:51Z
PasswordResetRequiredboolean

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

false
MFABindRequiredboolean

Indicates whether MFA must be enabled.

false

Examples

Sample success responses

JSONformat

{
  "RequestId": "29CB303C-1F05-43A6-A6BC-EBC5A797F8DB",
  "LoginProfile": {
    "UserPrincipalName": "test@example.onaliyun.com",
    "Status": "Active",
    "UpdateDate": "2020-10-14T03:47:51Z",
    "PasswordResetRequired": false,
    "MFABindRequired": false
  }
}

Error codes

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