Class ApiGatewayv1CognitoAuthorizer

ApiGatewayv1CognitoAuthorizer is a specialization of an ApiGatewayv1JwtAuthorizer and implements authentication logic for API Gateway v1 requests when using Cognito..

Hierarchy

Constructors

constructor

Properties

_logger adminClaim claims? event groupClaim issuerUrl jwksUrl?

Methods

assertAdmin assertAuthenticated assertGroup authenticate getClaim getEMail getGroups getSubject hasGroup isAdmin isAuthenticated

Constructors

constructor

Properties

Protected _logger

_logger: LambdaLog

Protected adminClaim

adminClaim: string

Protected Optional claims

claims?: {
    [name: string]: string | number | boolean | string[];
}

The claims of the authenticated user.

Type declaration

  • [name: string]: string | number | boolean | string[]

Protected event

event: APIGatewayProxyWithCognitoAuthorizerEvent

Protected groupClaim

groupClaim: string

Protected issuerUrl

issuerUrl: string

Protected Optional jwksUrl

jwksUrl?: string

Methods

assertAdmin

assertAuthenticated

assertGroup

  • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

    Parameters

    • group: string

      The name of the group to check.

    Returns void

authenticate

  • Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

    Returns Promise<void>

getClaim

  • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

    Parameters

    • name: string

      The name of the claim to retrieve.

    Returns undefined | string | number | boolean | string[]

getEMail

getGroups

  • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

    Returns string[]

getSubject

hasGroup

  • Returns true if the user belongs to the specified group, false otherwise.

    Parameters

    • group: string

      The name of the group to check.

    Returns boolean

isAdmin

isAuthenticated

Settings

Member Visibility

Theme

Generated using TypeDoc