Interface IAuthOptions<P>

Options for the middy-middleware-jwt-auth

Type Parameters

  • P = any

Hierarchy

  • IAuthOptions

Properties

algorithm credentialsRequired? isPayload? secretOrPublicKey tokenSource?

Properties

algorithm

algorithm: EncryptionAlgorithms

Algorithm to verify JSON web token signature

Optional credentialsRequired

credentialsRequired?: boolean

An optional boolean that allows making authorization necessary

Optional isPayload

isPayload?: ((payload: any) => payload is P)

Type declaration

    • (payload: any): payload is P

    • An optional type guard function that verifies token payload structure

      Parameters

      • payload: any

      Returns payload is P

secretOrPublicKey

secretOrPublicKey: string | Buffer

A string or buffer containing either the secret for HMAC algorithms, or the PEM encoded public key for RSA and ECDSA

Optional tokenSource

tokenSource?: ((event: any) => string)

Type declaration

    • (event: any): string

    • An optional function to get the authorization token from the event

      Parameters

      • event: any

      Returns string

Settings

Member Visibility

Theme