Class JwtPayload

Hierarchy

  • JwtPayload

Constructors

constructor

Properties

apiContext application aud? byuId claimSource? clientId endUser endUserTenantId exp? iss? keyType netId personId preferredFirstName prefix restOfName sortName subscriber subscriberNetId? suffix surname surnamePosition tier userType version Schema

Methods

from

Constructors

constructor

  • Parameters

    • payload: {
          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;
      }

    Returns JwtPayload

Properties

Readonly apiContext

apiContext: string

Issuer Claims

Readonly application

application: {
    id: string;
    name: string;
    tier: string;
}

Type declaration

  • Readonly id: string
  • Readonly name: string
  • Readonly tier: string

Optional Readonly aud

aud?: string | string[]

Readonly byuId

byuId: string

Client Claims

Optional Readonly claimSource

claimSource?: string

Readonly clientId

clientId: string

Readonly endUser

endUser: string

Readonly endUserTenantId

endUserTenantId: string

Optional Readonly exp

exp?: number

Optional Readonly iss

iss?: string

Readonly keyType

keyType: string

Readonly netId

netId: string

Readonly personId

personId: string

Readonly preferredFirstName

preferredFirstName: string

Readonly prefix

prefix: string

Readonly restOfName

restOfName: string

Readonly sortName

sortName: string

Readonly subscriber

subscriber: string

Optional Readonly subscriberNetId

subscriberNetId?: string

Readonly suffix

suffix: string

Readonly surname

surname: string

Readonly surnamePosition

surnamePosition: string

Readonly tier

tier: string

Readonly userType

userType: string

Readonly version

version: string

Static Schema

Schema: 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>;
}>]> = ...

Methods

Static from

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc