GetSecurityPreference - Resource Access Management - Alibaba Cloud Documentation Center

You can call GetSecurityPreference to query the global security preferences for Resource Access Management (RAM) users.

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:GetSecurityPreference

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response that is returned.
SecurityPreference	object	The information about security preferences.
AccessKeyPreference	object	The AccessKey preferences.
AllowUserToManageAccessKeys	boolean	Indicates whether RAM users can manage their own AccessKey pairs. Valid values: true: Allowed. false: Not allowed.	false
LoginProfilePreference	object	The logon preferences.
EnableSaveMFATicket	boolean	Indicates whether to save the multi-factor authentication (MFA) status for seven days after a RAM user logs on using MFA. Valid values: true: Allowed. false: Not allowed.	false
LoginSessionDuration	integer	The logon session duration for RAM users. Unit: hours.	6
LoginNetworkMasks	string	The logon mask.	10.0.0.0/8
AllowUserToChangePassword	boolean	Indicates whether RAM users can manage their own passwords. Valid values: true: Allowed. false: Not allowed.	true
OperationForRiskLogin `deprecated`	string	Indicates whether to use MFA for secondary authentication during a risk-based logon. Valid values: autonomous (default): The secondary authentication can be skipped. The attachment of an MFA device is not required. enforceVerify: The secondary authentication is required.	autonomous
MFAOperationForLogin	string	Specifies whether MFA is required for logon. This parameter replaces the EnforceMFAForLogin parameter. The original parameter is still valid. Use this new parameter. Valid values: mandatory: MFA is required for all RAM users. This value corresponds to true for the EnforceMFAForLogin parameter. independent (default): The MFA configuration of each RAM user is used. This value corresponds to false for the EnforceMFAForLogin parameter. adaptive: MFA is required only for risk-based logons.	adaptive
AllowUserToLoginWithPasskey	boolean	Indicates whether RAM users can log on using passkeys. Valid values: true: Allowed. false: Not allowed.	true
MFAPreference	object	The MFA preferences.
AllowUserToManageMFADevices	boolean	Indicates whether RAM users can manage their own MFA devices. Valid values: true: Allowed. false: Not allowed.	false
VerificationPreference	object	The preferences for MFA methods.
VerificationTypes	array	The MFA methods.
	string	The MFA method. Valid values: sms: secure phone email: security email address	["sms","email"]
PersonalInfoPreference	object	The personal information preferences.
AllowUserToManagePersonalDingTalk	boolean	Indicates whether RAM users can manage the attachment and detachment of their personal DingTalk accounts. Valid values: true: Allowed. false: Not allowed.	true
MaxIdleDays	object	The configuration of the maximum idle period, in days.
MaxIdleDaysForUsers	integer	The maximum idle period for RAM users, in days. If a RAM user with console logon enabled remains inactive for this period, their console logon is automatically disabled the next day. This does not apply to single sign-on (SSO) logons. The default value is 730.	730
MaxIdleDaysForAccessKeys	integer	The maximum idle period for the AccessKey pair of a RAM user, in days. If an AccessKey pair remains unused for this period, it is automatically disabled the next day. The default value is 730.	730
RequestId	string	The request ID.	30C9068D-FBAA-4998-9986-8A562FED0BC3

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.