Enable Secure Logon for RAM Users via CreateLoginProfile API - Resource Access Management

Creates a logon configuration for a Resource Access Management (RAM) user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ram:CreateLoginProfile

create

*User

acs:ram::{#accountId}:user/{#UserName}

None

Request parameters

Parameter	Type	Required	Description	Example
UserPrincipalName	string	Yes	The logon name of the RAM user.	test@example.onaliyun.com
Password	string	No	The logon password for the RAM user. The password must meet the password policy.	mypassword
PasswordResetRequired	boolean	No	Specifies whether the RAM user must reset the password at the next logon. Valid values: true false (default)	false
MFABindRequired	boolean	No	Specifies whether the RAM user must enable multi-factor authentication (MFA). Valid values: true: MFA is required. The RAM user must bind an MFA device at the next logon. false (default): MFA is not required.	false
Status	string	No	Specifies whether to enable password-based logon to the console. Valid values: Active (default): Enable Inactive: Disable	Active

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	29CB303C-1F05-43A6-A6BC-EBC5A797F8DB
LoginProfile	object	The console logon settings of the RAM user.
UserPrincipalName	string	The logon name of the RAM user.	test@example.onaliyun.com
Status	string	Indicates whether password-based logon for the console is enabled or disabled.	Active
UpdateDate	string	The time when the logon configuration was last updated.	2020-10-14T03:47:51Z
PasswordResetRequired	boolean	Indicates whether the RAM user must reset the password at the next logon.	false
MFABindRequired	boolean	Indicates whether the RAM user is required to enable MFA.	false
PasswordStatus	string	The status of the initial password. This password is set when a logon configuration is created or when console logon is re-enabled. Valid values "NotInitial": The password is not an initial password. "InitialValid": The initial password is valid. "InitialExpired": The initial password has expired.	NotInitial

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.