/v2/apis/{apiId}/authorizers/{authorizerId}

PATCH

Updates an Authorizer.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v2/apis//authorizers/' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
  "AuthorizerCredentialsArn": "string",
  "AuthorizerId": "string",
  "AuthorizerPayloadFormatVersion": "string",
  "AuthorizerResultTtlInSeconds": 0,
  "AuthorizerType": "REQUEST",
  "AuthorizerUri": "string",
  "EnableSimpleResponses": true,
  "IdentitySource": {},
  "IdentityValidationExpression": "string",
  "JwtConfiguration": {
    "Audience": [],
    "Issuer": "string"
  },
  "Name": "string"
}

Request

Path Params

apiId

string

required

The API identifier.

authorizerId

string

required

The authorizer identifier.

Body Params application/json

authorizerCredentialsArn

string

optional

Represents an Amazon Resource Name (ARN).

authorizerPayloadFormatVersion

string

optional

A string with a length between [1-64].

authorizerResultTtlInSeconds

integer

optional

An integer with a value between [0-3600].

>= 0<= 3600

authorizerType

enum<string>

optional

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).

Allowed values:

REQUESTJWT

authorizerUri

string

optional

A string representation of a URI with a length between [1-2048].

enableSimpleResponses

boolean

optional

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[string]

optional

The identity source for which authorization is requested. 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

m e t h o d . re q u es t . h e a d er . A u t h,

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.

identityValidationExpression

string

optional

A string with a length between [0-1024].

jwtConfiguration

object

optional

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Audience

array[string]

optional

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

Issuer

string

optional

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp..amazonaws.com/
. Required for the JWT authorizer type. Supported only for HTTP APIs.

name

string

optional

A string with a length between [1-128].

Examples

Responses

🟢200Success

application/json

Body

AuthorizerCredentialsArn

string

optional

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 REQUEST authorizers.

AuthorizerId

string

optional

The authorizer identifier.

AuthorizerPayloadFormatVersion

string

optional

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

AuthorizerResultTtlInSeconds

integer

optional

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.

>= 0<= 3600

AuthorizerType

enum<string>

optional

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).

Allowed values:

REQUESTJWT

AuthorizerUri

string

optional

The authorizer's Uniform Resource Identifier (URI). For 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::function:/invocations. In general, the URI has this form: arn:aws:apigateway::lambda:path/
, 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. Supported only for REQUEST authorizers.

EnableSimpleResponses

boolean

optional

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

object

optional

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with

, f ore x am pl e,

request.header.Auth,

re q u es t . q u erys t r in g . N am e . T h ese p a r am e t ers a re u se d t o p er f or m r u n t im e v a l i d a t i o n f or L amb d a - ba se d a u t h or i zers b y v er i f y in g a ll o f t h e i d e n t i t y - re l a t e d re q u es tp a r am e t ers a re p rese n t in t h ere q u es t, n o t n u ll, an d n o n - e m pt y . O n l y w h e n t hi s i s t r u e d oes t h e a u t h or i zer in v o k e t h e a u t h or i zer L amb d a f u n c t i o n . Ot h er w i se, i t re t u r n s a 401 U na u t h or i ze d res p o n se w i t h o u t c a ll in g t h e L amb d a f u n c t i o n . F orH TTP A P I s, i d e n t i t yso u rces a re a l so u se d a s t h ec a c h e k ey w h e n c a c hin g i se nab l e d . T o l e a r nm ore, see < ah re f = " h ttp s : // d ocs . a w s . ama zo n . co m / a p i g a t e w a y / l a t es t / d e v e l o p er gu i d e / h ttp - a p i - l amb d a - a u t h or i zer . h t m l " > W or kin g w i t h A W S L amb d aa u t h or i zers f orH TTP A P I s < / a > . < / p >< p > F or J W T, a s in g l ee n t ry t ha t s p ec i f i es w h ere t oe x t r a c tt h e J SON W e b T o k e n (J W T) f ro minb o u n d re q u es t s . C u rre n tl yo n l y h e a d er - ba se d an d q u ery p a r am e t er - ba se d se l ec t i o n s a res u pp or t e d, f ore x am pl e

request.header.Authorization.

IdentityValidationExpression

string

optional

The validation expression does not apply to the REQUEST authorizer.

JwtConfiguration

object

optional

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Audience

array[string]

optional

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

Issuer

string

optional

Name

string

optional

The name of the authorizer.

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

Modified at 2023-08-15 05:49:07

/v2/apis/{apiId}/authorizers/{authorizerId}

/v2/apis/{apiId}/cors