MonoCloud Authentication SDK
    Preparing search index...

    Interface UserinfoResponse<TAddress>

    Represents the OpenID Connect UserInfo response.

    interface UserinfoResponse<TAddress extends Address = Address> {
        address?: TAddress;
        birthdate?: string;
        email?: string;
        email_verified?: boolean;
        family_name?: string;
        gender?: string;
        given_name?: string;
        groups?: Group[];
        locale?: string;
        middle_name?: string;
        name?: string;
        nickname?: string;
        phone_number?: string;
        phone_number_verified?: boolean;
        picture?: string;
        preferred_username?: string;
        profile?: string;
        sub: string;
        updated_at?: number;
        website?: string;
        zoneinfo?: string;
        [key: string]: unknown;
    }

    Type Parameters

    Hierarchy

    Indexable

    • [key: string]: unknown

      Additional provider-specific claims.

    Index

    Properties

    address? birthdate? email? email_verified? family_name? gender? given_name? groups? locale? middle_name? name? nickname? phone_number? phone_number_verified? picture? preferred_username? profile? sub updated_at? website? zoneinfo?

    Properties

    address?: TAddress

    Postal address.

    birthdate?: string

    Birthday.

    email?: string

    Email address.

    email_verified?: boolean

    Whether the email address has been verified by the provider.

    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.

    locale?: string

    Locale.

    middle_name?: string

    Middle name(s).

    name?: string

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

    nickname?: string

    Casual name used by the user.

    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.

    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