auth.jwtAuth package

public struct JWTAuthenticator

Represents a JWT Authenticator

Field Name Data Type Description Default Value
jwtValidatorConfig JWTValidatorConfig JWTValidatorConfig object []
authCache Cache Authentication cache object []
  • <JWTAuthenticator> authenticate(string jwtToken) returns (boolean | error)

    Authenticate with a jwt token

    Parameter Name Data Type Description
    jwtToken string Jwt token extracted from the authentication header

    Return Variable Data Type Description
    boolean | error boolean: true if authentication is a success, else false
  • <JWTAuthenticator> JWTAuthenticator.<init>()

public function createAuthenticator() returns (JWTAuthenticator)

Creates a JWT Authenticator instance

Return Variable Data Type Description
JWTAuthenticator JWTAuthenticator instance