Interface ByuJwtProviderOptions

Hierarchy

Properties

additionalValidations?: ValidationFunction<TIntersect<[TObject<{
    aud: TOptional<TUnion<[TString, TArray<TString>]>>;
    exp: TOptional<TNumber>;
    iss: TOptional<TString>;
}>, TObject<{
    http://wso2.org/claims/apicontext: TString;
    http://wso2.org/claims/applicationid: TString;
    http://wso2.org/claims/applicationname: TString;
    http://wso2.org/claims/applicationtier: TString;
    http://wso2.org/claims/client_id: TString;
    http://wso2.org/claims/enduser: TString;
    http://wso2.org/claims/enduserTenantId: TString;
    http://wso2.org/claims/keytype: TEnum<typeof KeyType>;
    http://wso2.org/claims/subscriber: TString;
    http://wso2.org/claims/tier: TString;
    http://wso2.org/claims/usertype: TEnum<typeof UserType>;
    http://wso2.org/claims/version: TString;
}>, TObject<{
    http://byu.edu/claims/client_byu_id: TString;
    http://byu.edu/claims/client_claim_source: TEnum<typeof ClientClaimSource>;
    http://byu.edu/claims/client_name_prefix: TString;
    http://byu.edu/claims/client_name_suffix: TString;
    http://byu.edu/claims/client_net_id: TString;
    http://byu.edu/claims/client_person_id: TString;
    http://byu.edu/claims/client_preferred_first_name: TString;
    http://byu.edu/claims/client_rest_of_name: TString;
    http://byu.edu/claims/client_sort_name: TString;
    http://byu.edu/claims/client_subscriber_net_id: TString;
    http://byu.edu/claims/client_surname: TString;
    http://byu.edu/claims/client_surname_position: TString;
}>, TObject<{
    http://byu.edu/claims/resourceowner_byu_id: TOptional<TString>;
    http://byu.edu/claims/resourceowner_net_id: TOptional<TString>;
    http://byu.edu/claims/resourceowner_person_id: TOptional<TString>;
    http://byu.edu/claims/resourceowner_preferred_first_name: TOptional<TString>;
    http://byu.edu/claims/resourceowner_prefix: TOptional<TString>;
    http://byu.edu/claims/resourceowner_rest_of_name: TOptional<TString>;
    http://byu.edu/claims/resourceowner_sort_name: TOptional<TString>;
    http://byu.edu/claims/resourceowner_suffix: TOptional<TString>;
    http://byu.edu/claims/resourceowner_surname: TOptional<TString>;
    http://byu.edu/claims/resourceowner_surname_position: TOptional<TString>;
}>]>, TransformedJwtPayload>[]

An optional array of functions that will also be used to validate the JWT.

algorithms?: Algorithm[]
allowedAud?: string | RegExp | (string | RegExp)[]
allowedIss?: string | RegExp | (string | RegExp)[]
allowedJti?: string | RegExp | (string | RegExp)[]
allowedNonce?: string | RegExp | (string | RegExp)[]
allowedSub?: string | RegExp | (string | RegExp)[]
basePath?: string
cache?: number | boolean
cacheTTL?: number
checkTyp?: string
clockTimestamp?: number
clockTolerance?: number
complete?: boolean
development?: boolean
discoveryEndpoint?: string
errorCacheTTL?: number | ((tokenError) => number)

Type declaration

    • (tokenError): number
    • Parameters

      • tokenError: TokenError

      Returns number

ignoreExpiration?: boolean
ignoreNotBefore?: boolean
issuer?: string
key?: string
maxAge?: number
prefix?: string
requiredClaims?: string[]

Generated using TypeDoc