All Products
Search
Document Center

ApsaraMQ for MQTT:DeleteCustomAuthIdentity

Last Updated:Aug 22, 2024

Deletes an identity for custom authorization.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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-cn-0pp12gl****
UsernamestringYes

The username.

test
IdentityTypestringYes

The identity type. Valid values:

  • USER
  • CLIENT
USER
ClientIdstringNo

The client ID if you set IdentityType to CLIENT.

GID_test@@@test

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The request ID.

11568B5B-13A8-4E72-9DBA-3A14F7D3****
Codeinteger

The HTTP status code. The status code 200 indicates that the request is successful. Other status codes indicate that the request failed.

200
Successboolean

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

True
Messagestring

The returned message.

operation success.

Examples

Sample success responses

JSONformat

{
  "RequestId": "11568B5B-13A8-4E72-9DBA-3A14F7D3****",
  "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.