POST

/test-authorization

http://iot.{region}.amazonaws.com/test-authorization

Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TestAuthorization</a> action.

Access Token Required: API Key

Query Params

clientIdstring

The MQTT client ID.

Body Params

authInfosarrayrequired

A list of authorization info objects. Simulating authorization will create a response for each <code>authInfo</code> object in the list.

principalstring

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

policyNamesToAddarray

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

policyNamesToSkiparray

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

cognitoIdentityPoolIdstring

The Cognito identity pool ID.

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/test-authorization' \
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}