MonoCloud Authentication SDK
    Preparing search index...

    Interface IdTokenClaims

    Standard OpenID Connect ID Token claims.

    interface IdTokenClaims {
        acr?: string;
        address?: Address;
        amr?: string[];
        at_hash?: string;
        aud: string | string[];
        auth_time?: number;
        azp?: string;
        birthdate?: string;
        c_hash?: string;
        email?: string;
        email_verified?: boolean;
        exp: number;
        family_name?: string;
        gender?: string;
        given_name?: string;
        groups?: Group[];
        iat: number;
        iss: string;
        locale?: string;
        middle_name?: string;
        name?: string;
        nbf?: number;
        nickname?: string;
        nonce?: string;
        phone_number?: string;
        phone_number_verified?: boolean;
        picture?: string;
        preferred_username?: string;
        profile?: string;
        s_hash?: string;
        sub: string;
        updated_at?: number;
        website?: string;
        zoneinfo?: string;
        [key: string]: unknown;
    }

    Hierarchy

    Indexable

    • [key: string]: unknown

      Additional provider-specific claims.

    Index

    Properties

    acr? address? amr? at_hash? aud auth_time? azp? birthdate? c_hash? email? email_verified? exp family_name? gender? given_name? groups? iat iss locale? middle_name? name? nbf? nickname? nonce? phone_number? phone_number_verified? picture? preferred_username? profile? s_hash? sub updated_at? website? zoneinfo?

    Properties

    acr?: string

    Authentication Context Class Reference. Indicates the assurance level of the authentication performed.

    address?: Address

    Postal address.

    amr?: string[]

    Authentication Methods References. Lists the authentication methods used (for example: pwd, mfa, otp).

    at_hash?: string

    Access token hash. Used to validate access tokens returned alongside the ID token.

    aud: string | string[]

    Intended audience(s) of the token.

    auth_time?: number

    Time when the end-user authentication occurred (Unix epoch seconds).

    azp?: string

    Authorized party - identifies the client to which the ID token was issued.

    birthdate?: string

    Birthday.

    c_hash?: string

    Authorization code hash. Used to validate authorization codes returned with hybrid flows.

    email?: string

    Email address.

    email_verified?: boolean

    Whether the email address has been verified by the provider.

    exp: number

    Expiration time of the token (Unix epoch seconds).

    family_name?: string

    Surname(s) / last name.

    gender?: string

    Gender.

    given_name?: string

    Given name(s) / first name.

    groups?: Group[]

    Group memberships for the user.

    iat: number

    Time at which the token was issued (Unix epoch seconds).

    iss: string

    Issuer identifier - the authorization server that issued the token.

    locale?: string

    Locale.

    middle_name?: string

    Middle name(s).

    name?: string

    Full name of the user (e.g. "Jane Doe").

    nbf?: number

    Not-before time (Unix epoch seconds).

    nickname?: string

    Casual name used by the user.

    nonce?: string

    Nonce value used to associate the authentication request with the issued ID token and prevent replay attacks.

    phone_number?: string

    Phone number (formatted in E.164 standard).

    phone_number_verified?: boolean

    Whether the phone number has been verified by the provider.

    picture?: string

    URL of the user's profile picture.

    preferred_username?: string

    Preferred username.

    profile?: string

    URL of the user's profile page.

    s_hash?: string

    State hash (used in some hybrid flow validations).

    sub: string

    Subject identifier - a unique, stable identifier for the user within the issuer.

    updated_at?: number

    Time the user's information was last updated (seconds since epoch).

    website?: string

    URL of the user's website.

    zoneinfo?: string

    Time zone name.

    Settings

    On This Page

    Properties