GetSecurityPreference - Resource Access Management - Alibaba Cloud Documentation Center

Queries the security preferences.

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
SecurityPreference	object	The security preferences.
AccessKeyPreference	object	The AccessKey pair preference.
AllowUserToManageAccessKeys	boolean	Indicates whether Resource Access Management (RAM) users can manage their AccessKey pairs. Valid values: true false	false
MFAPreference	object	The multi-factor authentication (MFA) preference.
AllowUserToManageMFADevices	boolean	Indicates whether RAM users can manage their MFA devices. Valid values: true false	true
LoginProfilePreference	object	The logon preference.
EnableSaveMFATicket	boolean	Indicates whether RAM users can save security codes for MFA during logon. Each security code is valid 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 that indicates the IP addresses from which logon to the Alibaba Cloud Management Console is allowed. This parameter applies to password-based logon and single sign-on (SSO). However, this parameter does not apply to API calls that are authenticated based on AccessKey pairs. If you specify a subnet mask, RAM users can use only the IP addresses in the subnet mask to log on to the Alibaba Cloud Management Console. If you do not specify a subnet mask, RAM users can use all IP addresses to log on to the Alibaba Cloud Management Console. If you want to specify more than one subnet mask, separate the masks with semicolons (;). Example: 192.168.0.0/16;10.0.0.0/8.	10.0.0.0/8
AllowUserToChangePassword	boolean	Indicates whether RAM users can change their passwords. Valid values: true false	true
PublicKeyPreference	object	The public key preference. Note This parameter is valid only for the Japan site.
AllowUserToManagePublicKeys	boolean	Indicates whether RAM users can manage their public keys. Valid values: true false	false
RequestId	string	The request ID.	DC1213F1-A9D5-4A01-A996-44983689126C

Examples

Success response

JSON format

{
  "SecurityPreference": {
    "AccessKeyPreference": {
      "AllowUserToManageAccessKeys": false
    },
    "MFAPreference": {
      "AllowUserToManageMFADevices": true
    },
    "LoginProfilePreference": {
      "EnableSaveMFATicket": false,
      "LoginSessionDuration": 6,
      "LoginNetworkMasks": "10.0.0.0/8",
      "AllowUserToChangePassword": true
    },
    "PublicKeyPreference": {
      "AllowUserToManagePublicKeys": false
    }
  },
  "RequestId": "DC1213F1-A9D5-4A01-A996-44983689126C"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.