AddCustomAuthIdentity - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Adds the information about identity authentication. The identity can be accurate to a client.

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
mq:AddCustomAuthIdentity	create	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	none	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: compares the password and the AccessKey secret. SIGNED: uses the HMAC_SHA1 algorithm to sign the client ID to obtain a password and then compares the password.	SIGNED

Response parameters

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

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
2025-01-17	The Error code has changed	View Change Details