InterfaceUserProfile

interface UserProfile {
    address?: string;
    areaCode?: string;
    bargain?: string;
    city?: string;
    country?: string;
    countryCallingCode?: string;
    department?: string;
    departmentHeadEmail?: string;
    departmentHeadFullName?: string;
    division?: string;
    email?: string;
    emailVerified?: boolean;
    employeeNumber?: string;
    firstName?: string;
    fullName?: string;
    groups?: string[];
    isSAMLUser?: boolean;
    lastName?: string;
    middleName?: string;
    phoneNumber?: string;
    phoneNumberVerified?: boolean;
    picture?: string;
    postalCode?: string;
    providerType?: string;
    providerUserId?: string;
    role?: string;
    state?: string;
    supervisor?: {
        email?: string;
        fullName?: string;
        providerUserId?: string;
    };
    userId: string;
    username: string;
    zipCode?: string;
}

Properties

address? areaCode? bargain? city? country? countryCallingCode? department? departmentHeadEmail? departmentHeadFullName? division? email? emailVerified? employeeNumber? firstName? fullName? groups? isSAMLUser? lastName? middleName? phoneNumber? phoneNumberVerified? picture? postalCode? providerType? providerUserId? role? state? supervisor? userId username zipCode?

Properties

Optionaladdress

address?: string

The user's address

OptionalareaCode

areaCode?: string

The user's area code

Optionalbargain

bargain?: string

The user's bargain

Optionalcity

city?: string

The user's city

Optionalcountry

country?: string

The user's country

OptionalcountryCallingCode

countryCallingCode?: string

The user's country calling code

Optionaldepartment

department?: string

The user's department

OptionaldepartmentHeadEmail

departmentHeadEmail?: string

The users' department head's email address

OptionaldepartmentHeadFullName

departmentHeadFullName?: string

The users' department head's full name

Optionaldivision

division?: string

The user's division

Optionalemail

email?: string

The user's email address

OptionalemailVerified

emailVerified?: boolean

True if the email address is verified

OptionalemployeeNumber

employeeNumber?: string

The user's employee number

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

OptionalmiddleName

middleName?: string

The user's middle 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

OptionalpostalCode

postalCode?: string

The user's postal code

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

Optionalstate

state?: string

The user's state

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

OptionalzipCode

zipCode?: string

The user's ZIP code

Settings

On This Page

Properties