@oneblink/sdk-core
    Preparing search index...

    Interface UserProfile

    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;
    }
    Index

    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

    address?: string

    The user's address

    areaCode?: string

    The user's area code

    bargain?: string

    The user's bargain

    city?: string

    The user's city

    country?: string

    The user's country

    countryCallingCode?: string

    The user's country calling code

    department?: string

    The user's department

    departmentHeadEmail?: string

    The users' department head's email address

    departmentHeadFullName?: string

    The users' department head's full name

    division?: string

    The user's division

    email?: string

    The user's email address

    emailVerified?: boolean

    True if the email address is verified

    employeeNumber?: string

    The user's employee number

    firstName?: string

    The user's first name

    fullName?: string

    The user's full name

    groups?: string[]

    The users list of groups from a SAML configuration

    isSAMLUser?: boolean

    true if the user logged in using a SAML provider

    lastName?: string

    The user's last name

    middleName?: string

    The user's middle name

    phoneNumber?: string

    The user's phone number from a SAML configuration

    phoneNumberVerified?: boolean

    True if the phone number is verified

    picture?: string

    A URL to a picture of the user

    postalCode?: string

    The user's postal code

    providerType?: string

    Which provider was used to login

    providerUserId?: string

    The id of the user from the login provider

    role?: string

    The user's role from a SAML configuration

    state?: string

    The user's state

    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: string

    The id of the user from OneBlink

    username: string

    The username used to login

    zipCode?: string

    The user's ZIP code

    Settings

    Member Visibility

    On This Page

    Properties