Interface UserProfile

interface UserProfile {
    email?: string;
    emailVerified?: boolean;
    firstName?: string;
    fullName?: string;
    groups?: string[];
    isSAMLUser?: boolean;
    lastName?: string;
    phoneNumber?: string;
    phoneNumberVerified?: boolean;
    picture?: string;
    providerType?: string;
    providerUserId?: string;
    role?: string;
    supervisor?: {
        email?: string;
        fullName?: string;
        providerUserId?: string;
    };
    userId: string;
    username: string;
}

Properties

email? emailVerified? firstName? fullName? groups? isSAMLUser? lastName? phoneNumber? phoneNumberVerified? picture? providerType? providerUserId? role? supervisor? userId username

Properties

Optionalemail

email?: string

The user's email address

OptionalemailVerified

emailVerified?: boolean

True if the email address is verified

OptionalfirstName

firstName?: string

The user's first name

OptionalfullName

fullName?: string

The user's full name

Optionalgroups

groups?: string[]

The users list of groups from a SAML configuration

OptionalisSAMLUser

isSAMLUser?: boolean

true if the user logged in using a SAML provider

OptionallastName

lastName?: string

The user's last name

OptionalphoneNumber

phoneNumber?: string

The user's phone number from a SAML configuration

OptionalphoneNumberVerified

phoneNumberVerified?: boolean

True if the phone number is verified

Optionalpicture

picture?: string

A URL to a picture of the user

OptionalproviderType

providerType?: string

Which provider was used to login

OptionalproviderUserId

providerUserId?: string

The id of the user from the login provider

Optionalrole

role?: string

The user's role from a SAML configuration

Optionalsupervisor

supervisor?: {
    email?: string;
    fullName?: string;
    providerUserId?: string;
}

The user's supervisor information from a SAML configuration

Type declaration

  • Optionalemail?: string

    The user's supervisor's full email address

  • OptionalfullName?: string

    The user's supervisor's full name

  • OptionalproviderUserId?: string

    The user's supervisor's user id from the login provider

userId

userId: string

The id of the user from OneBlink

username

username: string

The username used to login

Settings

Member Visibility

On This Page

Properties