POST

/authorizer/{authorizerName}/test

http://iot.{region}.amazonaws.com/authorizer/{authorizerName}/test

<p>Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TestInvokeAuthorizer</a> action.</p>

Access Token Required: API Key

Path Parameters

authorizerNamestringrequired

The custom authorizer name.

Body Params

tokenstring

The token returned by your custom authentication service.

tlsContextobject

Specifies the TLS context to use for the test authorizer request.

httpContextobject

Specifies the HTTP context to use for the test authorizer request.

mqttContextobject

Specifies the MQTT context to use for the test authorizer request

tokenSignaturestring

The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iot.{region}.amazonaws.com/authorizer/{authorizerName}/test' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}