RAM authorization - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. Using RAM helps you avoid sharing your Alibaba Cloud account keys with other users and allows you to grant users the least privilege access. RAM uses permission policies to define authorizations. This topic describes the general structure of a RAM policy, and the policy statement elements (Action, Resource, and Condition) defined by ApsaraMQ for RAM permission policies. The RAM code (RamCode) for ApsaraMQ is mq , and the supported authorization granularity is OPERATION .

General structure of a policy

Permission policies support JSON format with the following general structure:

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "<Effect>",
      "Action": "<Action>",
      "Resource": "<Resource>",
      "Condition": {
        "<Condition_operator>": {
          "<Condition_key>": [
            "<Condition_value>"
          ]
        }
      }
    }
  ]
}

The following list describes the fields in the policy:

Version: Specifies the policy version number. It is fixed at 1.
Statement:
- Effect: Specifies the authorization result. Valid values: Allow and Deny.
- Action: Specifies one or more operations that are allowed or denied.
- Resource: Specifies the specific objects affected by the operations. You can use Alibaba Cloud Resource Names (ARNs) to describe specific resources.
- Condition: Specifies the conditions for the authorization to take effect. This field is optional.
  - Condition operator: Specifies the conditional operators. Different types of conditions support different conditional operators.
  - Condition_key: Specifies the condition keys.
  - Condition_value: Specifies the condition values.

Action

The following table lists the actions defined by ApsaraMQ. 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 support 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 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 that are applicable across all RAM-integrated services. For more information, see Common condition keys.
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	API	Access level	Resource type	Condition key	Dependent action
mq:RegisterCa	RegisterCaCertificate	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:BatchQuerySessionByClientIds	BatchQuerySessionByClientIds	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:UnregisterDeviceCertificate	InactivateDeviceCertificate	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:QueryMqttDeviceTrace	QueryMqttTraceMessageOfClient	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:QueryMqttSubTrace	QueryMqttTraceMessageSubscribe	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:ActiveCaCertificate	ActiveCaCertificate	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:GetDeviceCredential	GetDeviceCredential	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:UnregisterCaCertificate	InactivateCaCertificate	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:AddCustomAuthIdentity	AddCustomAuthIdentity	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:CloseConnection	CloseConnection	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:DeleteDeviceCertificate	DeleteDeviceCertificate	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:TagResources	TagResources	create	All Resource ``	None	mq:MqttInstanceAccess
mq:AddCustomAuthPermission	AddCustomAuthPermission	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:ListCaCertificate	ListCaCertificate	list	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:QueryCustomAuthConnectBlack	QueryCustomAuthConnectBlack	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:CreateMqttGroupId	CreateGroupId	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:UnTagResources	UntagResources	delete	All Resource ``	None	mq:MqttInstanceAccess
mq:DisasterRecovery	DisasterRecovery	update	All Resource ``	None	None
mq:QueryCustomAuthPermission	QueryCustomAuthPermission	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:ListDeviceCertificateByCaSn	ListDeviceCertificateByCaSn	list	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:UpdateCustomAuthIdentity	UpdateCustomAuthIdentity	update	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:RegisterDeviceCredential	RegisterDeviceCredential	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:MqttInstanceAccess	ListDeviceCredentialClientId	list	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:ActiveDeviceCertificate	ActiveDeviceCertificate	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:QueryMqttPubTrace	QueryMqttTraceMessagePublish	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:RefreshDeviceCredential	RefreshDeviceCredential	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:DeleteCaCertificate	DeleteCaCertificate	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:ListMqttInstance	ListInstances	list	All Resource ``	None	None
mq:DisasterDowngrade	DisasterDowngrade	update	All Resource ``	None	None
mq:GetRegisterCode	GetRegisterCode	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:DeleteCustomAuthPermission	DeleteCustomAuthPermission	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:SetSniConfig	SetSniConfig	update	All Resource ``	None	mq:MqttInstanceAccess
mq:SendMessage	SendMessage	none	All Resource ``	None	None
mq:ApplyToken	ApplyToken	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:DeleteCustomAuthConnectBlack	DeleteCustomAuthConnectBlack	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:MqttInstanceAccess	QuerySessionByClientId	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:QueryCustomAuthIdentity	QueryCustomAuthIdentity	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:UpdateCustomAuthPermission	UpdateCustomAuthPermission	update	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:RevokeToken	RevokeToken	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:ListTagResources	ListTagResources	list	All Resource ``	None	mq:MqttInstanceAccess
mq:DeleteCustomAuthIdentity	DeleteCustomAuthIdentity	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:DeleteMqttGroupId	DeleteGroupId	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:QueryToken	QueryToken	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:AddCustomAuthConnectBlack	AddCustomAuthConnectBlack	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:ListMqttGroupId	ListGroupId	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:GetCaCertificate	GetCaCertificate	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:QueryMqttDeviceTrace	QueryMqttTraceDevice	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:MqttInstanceAccess	UnRegisterDeviceCredential	delete	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	None
mq:GetDeviceCertificate	GetDeviceCertificate	get	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess
mq:ListDeviceCertificate	ListDeviceCertificate	list	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	None	mq:MqttInstanceAccess

Resource

The following table lists the resources defined by ApsaraMQ. Specify them in the Resource element of RAM policy statements to grant permissions for specific operations. They are uniquely identified by ARNs. Format: acs:{#ramcode}:{#regionId}:{#accountId}:{#resourceType}:

acs: The initialism of Alibaba Cloud service, which indicates the public cloud of Alibaba Cloud.
{#ramcode}: The code used in RAM to indicate an Alibaba Cloud service.
{#regionId}: The region ID. If the resource covers all regions, set it to an asterisk (*).
{#accountId}: The ID of the Alibaba Cloud account. If the resource covers all Alibaba Cloud accounts, set it to an asterisk (*).
{#resourceType}: The service-defined resource identifier. It supports a hierarchical structure, which is similar to a file path. If the statement covers global resources, set it to an asterisk (*).

Resource type	ARN
Instance	acs:mq:{#regionId}:{#accountId}:{#InstanceId}

Condition

ApsaraMQ does not define product-level condition keys. However, you can use Alibaba Cloud common condition keys for access control. For more information, see Common condition keys.

How to create custom RAM policies?

You can create custom policies and grant them to RAM users, RAM user groups, or RAM roles. For instructions, see: