authorizers

Creates, updates, deletes, gets or lists an authorizers resource.

Overview

Name	authorizers
Type	Resource
Id	aws.apigateway.authorizers

Fields

The following fields are returned by SELECT queries:

get_authorizer

Name	Datatype	Description
id	string	The identifier for the authorizer resource.
name	string	The name of the authorizer.
auth_type	string	Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_credentials	string	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, specify null.
authorizer_result_ttl_in_seconds	integer	The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
authorizer_uri	string	Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
identity_source	string	The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
identity_validation_expression	string	A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
provider_arns	array	A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
type_	string	The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. (TOKEN, REQUEST, COGNITO_USER_POOLS)

get_authorizers

Name	Datatype	Description
id	string	The identifier for the authorizer resource.
name	string	The name of the authorizer.
auth_type	string	Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_credentials	string	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, specify null.
authorizer_result_ttl_in_seconds	integer	The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
authorizer_uri	string	Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
identity_source	string	The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
identity_validation_expression	string	A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
provider_arns	array	A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
type_	string	The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool. (TOKEN, REQUEST, COGNITO_USER_POOLS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_authorizer	select	restapi_id, authorizer_id, region		Describe an existing Authorizer resource.
get_authorizers	select	restapi_id, region	position, limit	Describe an existing Authorizers resource.
create_authorizer	insert	restapi_id, region, name, type		Adds a new Authorizer resource to an existing RestApi resource.
update_authorizer	update	restapi_id, authorizer_id, region		Updates an existing Authorizer resource.
delete_authorizer	delete	restapi_id, authorizer_id, region		Deletes an existing Authorizer resource.
test_invoke_authorizer	exec	restapi_id, authorizer_id, region		Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
authorizer_id	string	Specifies a test invoke authorizer request's Authorizer ID.
region	string	AWS region (default: us-east-1)
restapi_id	string	The string identifier of the associated RestApi.
limit	integer	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position	string	The current pagination position in the paged result set.

SELECT examples

get_authorizer

Describe an existing Authorizer resource.

SELECT
id,
name,
auth_type,
authorizer_credentials,
authorizer_result_ttl_in_seconds,
authorizer_uri,
identity_source,
identity_validation_expression,
provider_arns,
type_
FROM aws.apigateway.authorizers
WHERE restapi_id = '{{ restapi_id }}' -- required
AND authorizer_id = '{{ authorizer_id }}' -- required
AND region = '{{ region }}' -- required
;

get_authorizers

Describe an existing Authorizers resource.

SELECT
id,
name,
auth_type,
authorizer_credentials,
authorizer_result_ttl_in_seconds,
authorizer_uri,
identity_source,
identity_validation_expression,
provider_arns,
type_
FROM aws.apigateway.authorizers
WHERE restapi_id = '{{ restapi_id }}' -- required
AND region = '{{ region }}' -- required
AND position = '{{ position }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_authorizer

Adds a new Authorizer resource to an existing RestApi resource.

INSERT INTO aws.apigateway.authorizers (
name,
type,
providerARNs,
authType,
authorizerUri,
authorizerCredentials,
identitySource,
identityValidationExpression,
authorizerResultTtlInSeconds,
restapi_id,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ providerARNs }}',
'{{ authType }}',
'{{ authorizerUri }}',
'{{ authorizerCredentials }}',
'{{ identitySource }}',
'{{ identityValidationExpression }}',
{{ authorizerResultTtlInSeconds }},
'{{ restapi_id }}',
'{{ region }}'
RETURNING
id,
name,
auth_type,
authorizer_credentials,
authorizer_result_ttl_in_seconds,
authorizer_uri,
identity_source,
identity_validation_expression,
provider_arns,
type_
;

Manifest

# Description fields are for documentation purposes
- name: authorizers
props:
  - name: restapi_id
    value: "{{ restapi_id }}"
    description: Required parameter for the authorizers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the authorizers resource.
  - name: name
    value: "{{ name }}"
  - name: type
    value: "{{ type }}"
    description: |
      The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    valid_values: ['TOKEN', 'REQUEST', 'COGNITO_USER_POOLS']
  - name: providerARNs
    value:
      - "{{ providerARNs }}"
  - name: authType
    value: "{{ authType }}"
  - name: authorizerUri
    value: "{{ authorizerUri }}"
  - name: authorizerCredentials
    value: "{{ authorizerCredentials }}"
  - name: identitySource
    value: "{{ identitySource }}"
  - name: identityValidationExpression
    value: "{{ identityValidationExpression }}"
  - name: authorizerResultTtlInSeconds
    value: {{ authorizerResultTtlInSeconds }}

UPDATE examples

update_authorizer

Updates an existing Authorizer resource.

UPDATE aws.apigateway.authorizers
SET 
patchOperations = '{{ patchOperations }}'
WHERE 
restapi_id = '{{ restapi_id }}' --required
AND authorizer_id = '{{ authorizer_id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
auth_type,
authorizer_credentials,
authorizer_result_ttl_in_seconds,
authorizer_uri,
identity_source,
identity_validation_expression,
provider_arns,
type_;

DELETE examples

delete_authorizer

Deletes an existing Authorizer resource.

DELETE FROM aws.apigateway.authorizers
WHERE restapi_id = '{{ restapi_id }}' --required
AND authorizer_id = '{{ authorizer_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

test_invoke_authorizer

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

EXEC aws.apigateway.authorizers.test_invoke_authorizer 
@restapi_id='{{ restapi_id }}' --required, 
@authorizer_id='{{ authorizer_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"headers": "{{ headers }}", 
"multiValueHeaders": "{{ multiValueHeaders }}", 
"pathWithQueryString": "{{ pathWithQueryString }}", 
"body": "{{ body }}", 
"stageVariables": "{{ stageVariables }}", 
"additionalContext": "{{ additionalContext }}"
}'
;