Menu
AWS IoT
API Reference

CreateAuthorizer

Creates an authorizer.

Request Syntax

POST /authorizer/authorizerName HTTP/1.1 Content-type: application/json { "authorizerFunctionArn": "string", "status": "string", "tokenKeyName": "string", "tokenSigningPublicKeys": { "string" : "string" } }

URI Request Parameters

The request requires the following URI parameters.

authorizerName

The authorizer name.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w=,@-]+

Request Body

The request accepts the following data in JSON format.

authorizerFunctionArn

The ARN of the authorizer's Lambda function.

Type: String

Required: Yes

status

The status of the create authorizer request.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

tokenKeyName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: Yes

tokenSigningPublicKeys

The public keys used to verify the digital signature returned by your custom authentication service.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9:_-]+

Value Length Constraints: Maximum length of 5120.

Required: Yes

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

authorizerArn

The authorizer ARN.

Type: String

authorizerName

The authorizer's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w=,@-]+

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The number of attached entities exceeds the limit.

HTTP Status Code: 410

ResourceAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: