All Products
Search
Document Center

ApsaraMQ for MQTT:UpdateCustomAuthIdentity

Last Updated:Dec 13, 2024

Updates the information about custom identity authentication.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the ApsaraMQ for MQTT instance.

post-111****
UsernamestringYes

The username.

test
SecretstringYes

The AccessKey secret.

xxxx
IdentityTypestringYes

The identity type. Valid values:

  • USER
  • CLIENT
USER
ClientIdstringNo

The client ID if you set IdentityType to CLIENT.

GID_test@@@test
SignModestringYes

The signature verification mode. ORIGIN: compares the password and 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

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

3F00084A-7F07-4B15-BADA-8903A4FB****
Codeinteger

The HTTP status code.

200
Successboolean

Indicates whether the request is successful. Valid values: true and false.

True
Messagestring

The returned message.

operation success.

Examples

Sample success responses

JSONformat

{
  "RequestId": "3F00084A-7F07-4B15-BADA-8903A4FB****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

Error codes

HTTP status codeError codeError message
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400InvalidParameter.%sAn error occurred while validating the parameter. The parameter may be missing or invalid.
404ApiNotSupportThe specified API is not supported.

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

Change history

Change timeSummary of changesOperation
No change history