Add Custom Authentication Identities via MQTT API - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

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

mq:AddCustomAuthIdentity

create

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Message Queue for MQTT instance.	mqtt-cn-xxxx
Username	string	Yes	The username.	test
Secret	string	Yes	The AccessKey secret.	xxxxx
IdentityType	string	Yes	The identity type. Valid values: USER CLIENT	USER
ClientId	string	No	The client ID if you set IdentityType to CLIENT.	GID_test@@@test
SignMode	string	Yes	The signature verification mode. ORIGIN: directly compares the password with the AccessKey secret. SIGNED: uses the HMAC_SHA1 algorithm to sign the client ID to derive a password, and then compares the password.	SIGNED

Response elements

Element	Type	Description	Example
	object	The schema object.
RequestId	string	The request ID.	020F6A43-19E6-4B6E-B846-44EB31DF****
Code	integer	The HTTP status code. A value of 200 indicates a successful request.	200
Success	boolean	Indicates whether the operation was successful. Valid values: true and false.	True
Message	string	The message returned.	operation success.

Examples

Success response

JSON format

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
400	Customauth.over.capacity	Over custom auth capacity.	User-defined permission quantity capacity exceeds the limit
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.