You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::JWTConfiguration

Inherits:

Struct

Object
Struct
Aws::ApiGatewayV2::Types::JWTConfiguration

show all

Defined in:: (unknown)

Overview

Note:

When passing JWTConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  audience: ["__string"],
  issuer: "UriWithLengthBetween1And2048",
}

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

Returned by:

Instance Attribute Summary collapse

#audience ⇒ Array<String>
A list of the intended recipients of the JWT.
#issuer ⇒ String
The base domain of the identity provider that issues JSON Web Tokens.

Instance Attribute Details

#audience ⇒ `Array<String>`

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.

Returns:

(Array<String>) —
A list of the intended recipients of the JWT.

#issuer ⇒ `String`

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.`region

.amazonaws.com/userPoolId`

. Required for the JWT authorizer type. Supported only for HTTP APIs.