These are the SDK reference docs. If you’re looking for docs to implement SuperTokens, you might want to check out the User Guides

Hierarchy

  • SupertokensLambdaEventV2
    • SessionEventV2

Index

Properties

Optional body

body?: string

Optional cookies

cookies?: string[]

headers

headers: APIGatewayProxyEventHeaders

isBase64Encoded

isBase64Encoded: boolean

Optional pathParameters

pathParameters?: APIGatewayProxyEventPathParameters

Optional queryStringParameters

queryStringParameters?: APIGatewayProxyEventQueryStringParameters

rawPath

rawPath: string

rawQueryString

rawQueryString: string

requestContext

requestContext: { accountId: string; apiId: string; authorizer?: { jwt: { claims: {}; scopes: string[] } }; domainName: string; domainPrefix: string; http: { method: string; path: string; protocol: string; sourceIp: string; userAgent: string }; requestId: string; routeKey: string; stage: string; time: string; timeEpoch: number }

Type declaration

  • accountId: string
  • apiId: string
  • Optional authorizer?: { jwt: { claims: {}; scopes: string[] } }
    • jwt: { claims: {}; scopes: string[] }
      • claims: {}
        • [name: string]: string | number | boolean | string[]
      • scopes: string[]
  • domainName: string
  • domainPrefix: string
  • http: { method: string; path: string; protocol: string; sourceIp: string; userAgent: string }
    • method: string
    • path: string
    • protocol: string
    • sourceIp: string
    • userAgent: string
  • requestId: string
  • routeKey: string
  • stage: string
  • time: string
  • timeEpoch: number

routeKey

routeKey: string

Optional session

Optional stageVariables

stageVariables?: APIGatewayProxyEventStageVariables

supertokens

supertokens: { response: { cookies: string[]; headers: { allowDuplicateKey: boolean; key: string; value: string | number | false | true }[] } }

Type declaration

  • response: { cookies: string[]; headers: { allowDuplicateKey: boolean; key: string; value: string | number | false | true }[] }
    • cookies: string[]
    • headers: { allowDuplicateKey: boolean; key: string; value: string | number | false | true }[]

version

version: string

Generated using TypeDoc