Class ByuJwt

constructor

• new ByuJwt(jwt, options?): ByuJwt

• Parameters

  • jwt: JwtData<{
        aud?: string | string[];
        exp?: number;
        iss?: string;
    } & {
        http://wso2.org/claims/apicontext: string;
        http://wso2.org/claims/applicationid: string;
        http://wso2.org/claims/applicationname: string;
        http://wso2.org/claims/applicationtier: string;
        http://wso2.org/claims/client_id: string;
        http://wso2.org/claims/enduser: string;
        http://wso2.org/claims/enduserTenantId: string;
        http://wso2.org/claims/keytype: KeyType;
        http://wso2.org/claims/subscriber: string;
        http://wso2.org/claims/tier: string;
        http://wso2.org/claims/usertype: UserType;
        http://wso2.org/claims/version: string;
    } & {
        http://byu.edu/claims/client_byu_id: string;
        http://byu.edu/claims/client_claim_source: ClientClaimSource;
        http://byu.edu/claims/client_name_prefix: string;
        http://byu.edu/claims/client_name_suffix: string;
        http://byu.edu/claims/client_net_id: string;
        http://byu.edu/claims/client_person_id: string;
        http://byu.edu/claims/client_preferred_first_name: string;
        http://byu.edu/claims/client_rest_of_name: string;
        http://byu.edu/claims/client_sort_name: string;
        http://byu.edu/claims/client_subscriber_net_id: string;
        http://byu.edu/claims/client_surname: string;
        http://byu.edu/claims/client_surname_position: string;
    } & {
        http://byu.edu/claims/resourceowner_byu_id?: string;
        http://byu.edu/claims/resourceowner_net_id?: string;
        http://byu.edu/claims/resourceowner_person_id?: string;
        http://byu.edu/claims/resourceowner_preferred_first_name?: string;
        http://byu.edu/claims/resourceowner_prefix?: string;
        http://byu.edu/claims/resourceowner_rest_of_name?: string;
        http://byu.edu/claims/resourceowner_sort_name?: string;
        http://byu.edu/claims/resourceowner_suffix?: string;
        http://byu.edu/claims/resourceowner_surname?: string;
        http://byu.edu/claims/resourceowner_surname_position?: string;
    }>

  • Optional options: JwtOptions<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>

  Returns ByuJwt

Readonly header

Readonly payload

Readonly signature

Static decode

Static from

Static verify