Interface JwtClient

interface JwtClient {
    createAuthSessionToken(
        payload: JwtAuthUserPayload,
    ): JwtSigAuthSessionReturnType;
    signToken(
        payload: Record<string, unknown>,
        secret: string,
        options?: SignTokenOptions,
    ): string;
    verifyToken(token: string): JwtAuthVerifiedSigPayload;
    verifyTokenFromRequest(
        request: ServerProxyRequestType,
    ): JwtAuthVerifiedSigPayload;
}

Index

Methods

createAuthSessionToken signToken verifyToken verifyTokenFromRequest

Methods

createAuthSessionToken

createAuthSessionToken(payload: JwtAuthUserPayload): JwtSigAuthSessionReturnType
creates a token when an id and email are provided
Parameters
- payload: JwtAuthUserPayload
  object containing the user id and the email
Returns JwtSigAuthSessionReturnType
- Defined in packages/services/src/services/integrations/jwt/JwtClient.ts:13

signToken

signToken(
    payload: Record<string, unknown>,
    secret: string,
    options?: SignTokenOptions,
): string
Signs a token with the given payload and secret
Parameters
- payload: Record<string, unknown>
  The payload to sign
- secret: string
  The secret to sign the token with
- Optionaloptions: SignTokenOptions
  Optional sign options
Returns string
- Defined in packages/services/src/services/integrations/jwt/JwtClient.ts:38

verifyToken

verifyToken(token: string): JwtAuthVerifiedSigPayload
verifies a given token against the appSessionSecret
Parameters
- token: string
Returns JwtAuthVerifiedSigPayload
- Defined in packages/services/src/services/integrations/jwt/JwtClient.ts:30

verifyTokenFromRequest

verifyTokenFromRequest(
request: ServerProxyRequestType,
): JwtAuthVerifiedSigPayload
Verify a token when a request is received from a http endpoint check headers, queryString and cookies
Parameters
- request: ServerProxyRequestType
  request object from the endpoint
Returns JwtAuthVerifiedSigPayload
- Defined in packages/services/src/services/integrations/jwt/JwtClient.ts:22