Authorizers
Represents the collection of authorizers for an API.
URI
/v2/apis/
apiId
/authorizers
HTTP methods
GET
Operation ID: GetAuthorizers
Gets the Authorizers
for an API.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apiId | String | True | The API identifier. |
Query parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | The next page of elements from this collection. Not valid for the last element of the collection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False | The maximum number of elements to be returned for this resource. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Authorizers | Success | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestException | One of the parameters in the request is invalid. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundException | The resource specified in the request was not found. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceededException | The client is sending more than the allowed number of requests per unit of time. |
POST
Operation ID: CreateAuthorizer
Creates an Authorizer
for an API.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apiId | String | True | The API identifier. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Authorizer | The request has succeeded and has resulted in the creation of a resource. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestException | One of the parameters in the request is invalid. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundException | The resource specified in the request was not found. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ConflictException | The resource already exists. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceededException | The client is sending more than the allowed number of requests per unit of time. |
Schemas
Request bodies
{ "name": "string", "authorizerType": enum, "authorizerUri": "string", "authorizerCredentialsArn": "string", "identitySource": [ "string" ], "identityValidationExpression": "string", "authorizerResultTtlInSeconds": integer, "jwtConfiguration": { "issuer": "string", "audience": [ "string" ] }, "authorizerPayloadFormatVersion": "string", "enableSimpleResponses": boolean }
Response bodies
{ "items": [ { "authorizerId": "string", "name": "string", "authorizerType": enum, "authorizerUri": "string", "authorizerCredentialsArn": "string", "identitySource": [ "string" ], "identityValidationExpression": "string", "authorizerResultTtlInSeconds": integer, "jwtConfiguration": { "issuer": "string", "audience": [ "string" ] }, "authorizerPayloadFormatVersion": "string", "enableSimpleResponses": boolean } ], "nextToken": "string" }
{ "authorizerId": "string", "name": "string", "authorizerType": enum, "authorizerUri": "string", "authorizerCredentialsArn": "string", "identitySource": [ "string" ], "identityValidationExpression": "string", "authorizerResultTtlInSeconds": integer, "jwtConfiguration": { "issuer": "string", "audience": [ "string" ] }, "authorizerPayloadFormatVersion": "string", "enableSimpleResponses": boolean }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string" }
Properties
Authorizer
Represents an authorizer.
Property | Type | Required | Description |
---|---|---|---|
authorizerCredentialsArn | string | False | Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for |
authorizerId | string | False | The authorizer identifier. |
authorizerPayloadFormatVersion | string | False | Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are |
authorizerResultTtlInSeconds | integer | False | The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. |
authorizerType | False | The authorizer type. Specify | |
authorizerUri | string | False | The authorizer's Uniform Resource Identifier (URI). For |
enableSimpleResponses | boolean | False | Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs. |
identitySource | Array of type string | False | The identity source for which authorization is requested. For a For |
identityValidationExpression | string | False | The validation expression does not apply to the |
jwtConfiguration | False | Represents the configuration of a JWT authorizer. Required for the | |
name | string | True | The name of the authorizer. |
AuthorizerType
The authorizer type. Specify REQUEST
for a Lambda function using incoming request parameters. Specify JWT
to use JSON Web Tokens (supported only for HTTP APIs).
REQUEST
JWT
Authorizers
Represents a collection of authorizers.
Property | Type | Required | Description |
---|---|---|---|
items | Array of type Authorizer | False | The elements from this collection. |
nextToken | string | False | The next page of elements from this collection. Not valid for the last element of the collection. |
BadRequestException
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Describes the error encountered. |
ConflictException
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Describes the error encountered. |
CreateAuthorizerInput
Represents the input parameters for a CreateAuthorizer
request.
Property | Type | Required | Description |
---|---|---|---|
authorizerCredentialsArn | string | False | Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for |
authorizerPayloadFormatVersion | string | False | Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are |
authorizerResultTtlInSeconds | integer | False | The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers. |
authorizerType | True | The authorizer type. Specify | |
authorizerUri | string | False | The authorizer's Uniform Resource Identifier (URI). For |
enableSimpleResponses | boolean | False | Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs. |
identitySource | Array of type string | True | The identity source for which authorization is requested. For a For |
identityValidationExpression | string | False | This parameter is not used. |
jwtConfiguration | False | Represents the configuration of a JWT authorizer. Required for the | |
name | string | True | The name of the authorizer. |
JWTConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
Property | Type | Required | Description |
---|---|---|---|
audience | Array of type string | False | A list of the intended recipients of the JWT. A valid JWT must provide an
|
issuer | string | False | The base domain of the identity provider that issues JSON Web Tokens. For example,
an Amazon Cognito user pool has the following format:
|
LimitExceededException
A limit has been exceeded. See the accompanying error message for details.
Property | Type | Required | Description |
---|---|---|---|
limitType | string | False | The limit type. |
message | string | False | Describes the error encountered. |
NotFoundException
The resource specified in the request was not found. See the message
field for more information.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Describes the error encountered. |
resourceType | string | False | The resource type. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: