/default-authorizer

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

/default-authorizer

Describes the default authorizer.

Requires permission to access the DescribeDefaultAuthorizer action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/default-authorizer'

Response Example

200 - Example 1

{
    "authorizerDescription": {
        "authorizerName": "string",
        "authorizerArn": "string",
        "authorizerFunctionArn": "string",
        "tokenKeyName": "string",
        "tokenSigningPublicKeys": {
            "property1": "string",
            "property2": "string"
        },
        "status": "ACTIVE",
        "creationDate": "string",
        "lastModifiedDate": "string",
        "signingDisabled": true
    }
}

Request

None

Responses

🟢200Success

application/json

Body

authorizerDescription

object

optional

The default authorizer's description.

authorizerName

string

optional

The authorizer name.

>= 1 characters<= 128 characters

Match pattern:

[\w=,@-]+

authorizerArn

string

optional

The authorizer ARN.

<= 2048 characters

authorizerFunctionArn

string

optional

The authorizer's Lambda function ARN.

<= 2048 characters

tokenKeyName

string

optional

The key used to extract the token from the HTTP headers.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

tokenSigningPublicKeys

object

optional

The public keys used to validate the token signature returned by your custom authentication service.

status

enum<string>

optional

The status of the authorizer.

Allowed values:

ACTIVEINACTIVE

creationDate

string <date-time>

optional

The UNIX timestamp of when the authorizer was created.

lastModifiedDate

string <date-time>

optional

The UNIX timestamp of when the authorizer was last updated.

signingDisabled

boolean

optional

Specifies whether IoT validates the token signature in an authorization request.

🟠480ResourceNotFoundException

🟠481InvalidRequestException

🟠482ThrottlingException

🟠483UnauthorizedException

🟠484ServiceUnavailableException

🟠485InternalFailureException

Modified at 2022-09-10 23:12:13

/wireless-gateways/{Id}/tasks