Class SyntheticsBasicAuthJWT

Object to handle JWT authentication when performing the test.

Hierarchy

  • SyntheticsBasicAuthJWT

Constructors

constructor

Properties

addClaims? additionalProperties? algorithm expiresIn? header? payload secret tokenPrefix? type

Constructors

constructor

Properties

Optional addClaims

addClaims?: SyntheticsBasicAuthJWTAddClaims

Standard JWT claims to automatically inject.

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

algorithm

algorithm: SyntheticsBasicAuthJWTAlgorithm

Algorithm to use for the JWT authentication.

Optional expiresIn

expiresIn?: number

Token time-to-live in seconds.

Optional header

header?: string

Custom JWT header as a JSON string.

payload

payload: string

JWT claims as a JSON string.

secret

secret: string

Signing key for the JWT authentication. Use the shared secret for HS256 or the private key (PEM format) for RS256 and ES256.

Optional tokenPrefix

tokenPrefix?: string

Prefix added before the token in the Authorization header. Defaults to Bearer.

type

type: SyntheticsBasicAuthJWTType

The type of authentication to use when performing the test.

Settings

Member Visibility

Theme

Generated using TypeDoc