Skip to main content

# User

    type User = {
      cellPhone: string;
      chumId: string;
      clientId: string;
      email: string;
      employeeId: string;
      firstName: string;
      id: string;
      instanceId: string;
      isAdmin: boolean;
      lastName: string;
      nmlsOriginatorId: string;
      personas: Personas[];
      phone: string;
      realm: string;
    };

User information

## Properties​

### cellPhone​

    cellPhone: string;

user's cell phone number

### chumId​

    chumId: string;

CHUM number

### clientId​

    clientId: string;

encompass client Id

### email​

    email: string;

user's email address

### employeeId​

    employeeId: string;

Employee number

### firstName​

    firstName: string;

user's first name

### id​

    id: string;

unique identifier for the user

### instanceId​

    instanceId: string;

instance id

### isAdmin​

    isAdmin: boolean;

flag to indicate if the user is an administrator

### lastName​

    lastName: string;

user's last name

### nmlsOriginatorId​

    nmlsOriginatorId: string;

NMLS number

### personas​

    personas: Personas[];

list of personas user has access to

### phone​

    phone: string;

user's phone number

### realm​

    realm: string;

legacy tenant id