AddCustomAuthIdentity - ApsaraMQ for MQTT

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

Debugging

There is currently no authorization information disclosed in the API.

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 and CLIENT.	USER
ClientId	string	No	The client ID if you set IdentityType to CLIENT.	GID_test@@@test
SignMode	string	No	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

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.

Sample success responses

JSONformat

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

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 time	Summary of changes	Operation

No change history