GetSecurityPreference - Resource Access Management - Alibaba Cloud Documentation Center

Queries the security preferences for RAM users.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
ram:GetSecurityPreference	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

For more information about common request parameters, see API Reference.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
SecurityPreference	object	The details of security preferences.
AccessKeyPreference	object	The AccessKey pair preference.
AllowUserToManageAccessKeys	boolean	Indicates whether RAM users can manage their AccessKey pairs. Valid values: true false	false
LoginProfilePreference	object	The logon preference.
EnableSaveMFATicket	boolean	Indicates whether RAM users can remember the multi-factor authentication (MFA) devices for seven days. Valid values: true false	false
LoginSessionDuration	integer	The validity period of the logon session of RAM users. Unit: hours.	6
LoginNetworkMasks	string	The subnet mask.	10.0.0.0/8
AllowUserToChangePassword	boolean	Indicates whether RAM users can change their passwords. Valid values: true false	true
OperationForRiskLogin	string	Indicates whether to enable MFA for RAM users who initiated unusual logons. Valid values: autonomous (default): yes. MFA is prompted for RAM users who initiated unusual logons. However, the RAM users are allowed to skip MFA. enforceVerify: MFA is prompted for RAM users who initiated unusual logons and the RAM users cannot skip MFA.	autonomous
MFAOperationForLogin	string	Indicates whether MFA is required for all RAM users when they log on to the Alibaba Cloud Management Console. Valid values: mandatory: MFA is required for all RAM users. If you use EnforceMFAForLogin, set the value to true. independent (default): User-specific settings are applied. If you use EnforceMFAForLogin, set the value to false. adaptive: MFA is required only for RAM users who initiated unusual logons.	adaptive
AllowUserToLoginWithPasskey	boolean	Indicates whether a RAM user can use a passkey for logon. Valid values: true false	true
MFAPreference	object	The MFA preference.
AllowUserToManageMFADevices	boolean	Indicates whether RAM users can manage their MFA devices. Valid values: true false	false
VerificationPreference	object	The MFA method preference.
VerificationTypes	array	The MFA methods.
VerificationType	string	The MFA method. Valid values: sms: mobile phone email: email	["sms","email"]
PersonalInfoPreference	object	The personal information preference.
AllowUserToManagePersonalDingTalk	boolean	Indicates whether RAM users can manage their personal DingTalk accounts, such as binding and unbinding of the accounts. Valid values: true false	true
MaxIdleDays	object	The maximum idle periods. Unit: days.
MaxIdleDaysForUsers	integer	The maximum number of days that a RAM user can stay idle. If a RAM user for whom console logon is enabled does not log on to the console in the previous specified number of days, console logon is automatically disabled for the RAM user on the next day. Single sign-on (SSO) is not involved. The default value is 730. You cannot change the value.	730
MaxIdleDaysForAccessKeys	integer	The maximum number of days that the AccessKey pair of a RAM user can stay unused. If an AccessKey pair is not used in the previous specified number of days, the AccessKey pair is automatically disabled on the next day. The default value is 730. You cannot change the value.	730
RequestId	string	The request ID.	30C9068D-FBAA-4998-9986-8A562FED0BC3

Examples

Sample success responses

JSONformat

{
  "SecurityPreference": {
    "AccessKeyPreference": {
      "AllowUserToManageAccessKeys": false
    },
    "LoginProfilePreference": {
      "EnableSaveMFATicket": false,
      "LoginSessionDuration": 6,
      "LoginNetworkMasks": "10.0.0.0/8",
      "AllowUserToChangePassword": true,
      "OperationForRiskLogin": "autonomous",
      "MFAOperationForLogin": "adaptive",
      "AllowUserToLoginWithPasskey": true
    },
    "MFAPreference": {
      "AllowUserToManageMFADevices": false
    },
    "VerificationPreference": {
      "VerificationTypes": [
        "[\"sms\",\"email\"]"
      ]
    },
    "PersonalInfoPreference": {
      "AllowUserToManagePersonalDingTalk": true
    },
    "MaxIdleDays": {
      "MaxIdleDaysForUsers": 730,
      "MaxIdleDaysForAccessKeys": 730
    }
  },
  "RequestId": "30C9068D-FBAA-4998-9986-8A562FED0BC3"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-01-08	The response structure of the API has changed	View Change Details
2024-12-19	The response structure of the API has changed	View Change Details
2024-08-14	API Description Update	View Change Details
2023-03-20	The response structure of the API has changed	View Change Details
2023-01-06	The response structure of the API has changed	View Change Details
2021-08-11	The response structure of the API has changed	View Change Details
2021-08-11	The response structure of the API has changed	View Change Details