Menu
AWS IoT
Developer Guide

SetDefaultAuthorizer

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

Request syntax:

POST /default-authorizer Content-type: application/json { "authorizerName": "string" }

Request Body Parameters:

Name

Type

Req?

Description

authorizerName

AuthorizerName

yes

The authorizer name.

Response syntax:

Content-type: application/json { "authorizerName": "string", "authorizerArn": "string" }

Response Body Parameters:

Name

Type

Req?

Description

authorizerName

AuthorizerName

no

The authorizer name.

authorizerArn

AuthorizerArn

no

The authorizer ARN.

Errors:

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

aws iot set-default-authorizer \ --authorizer-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "authorizerName": "string" }

cli-input-json fields:

Name

Type

Description

authorizerName

string

length max:128 min:1

pattern: [w=,@-]+

The authorizer name.

Output:

{ "authorizerName": "string", "authorizerArn": "string" }

cli output fields:

Name

Type

Description

authorizerName

string

length max:128 min:1

pattern: [w=,@-]+

The authorizer name.

authorizerArn

string

The authorizer ARN.

On this page: