Interface RegisterRequest

interface RegisterRequest {
    _id?: string;
    address?: UserAddress;
    birthdate?: string | Date;
    customFields?: any;
    email?: string;
    email_verified?: boolean;
    family_name?: string;
    gender?: string;
    generate_password?: boolean;
    given_name?: string;
    groups?: UserGroupMap[];
    identityCustomFields?: any;
    identityId?: string;
    invite_id?: string;
    locale?: string;
    mfa_enabled?: boolean;
    middle_name?: string;
    mobile_number?: string;
    mobile_number_obj?: UserMobile;
    mobile_number_verified?: boolean;
    need_reset_password?: boolean;
    nickname?: string;
    originalProviderUserId?: string[];
    password?: string;
    password_echo?: string;
    password_hash_info?: any;
    phone_number?: string;
    phone_number_obj?: UserMobile;
    phone_number_verified?: boolean;
    picture?: string;
    profile?: string;
    provider?: string;
    providerBusinessIds?: string[];
    providerUserId?: string;
    rawJSON?: string;
    roles?: string[];
    street_address?: string;
    sub?: string;
    trackId?: string;
    user_status_reason?: string;
    username?: string;
    userStatus?: string;
    website?: string;
    zoneinfo?: string;
}

Hierarchy (View Summary)

Properties

_id? address? birthdate? customFields? email? email_verified? family_name? gender? generate_password? given_name? groups? identityCustomFields? identityId? invite_id? locale? mfa_enabled? middle_name? mobile_number? mobile_number_obj? mobile_number_verified? need_reset_password? nickname? originalProviderUserId? password? password_echo? password_hash_info? phone_number? phone_number_obj? phone_number_verified? picture? profile? provider? providerBusinessIds? providerUserId? rawJSON? roles? street_address? sub? trackId? user_status_reason? username? userStatus? website? zoneinfo?

Properties

Optional_id

_id?: string

required if it's present in data for update.

Optionaladdress

address?: UserAddress

Address of the user

Optionalbirthdate

birthdate?: string | Date

User's birthdate in the format 'YYYY-MM-DD'

OptionalcustomFields

customFields?: any

Represents custom-specific fields that need to be configured in the system

Optionalemail

email?: string

Email of the user in string

Optionalemail_verified

email_verified?: boolean

Described whether user email has been verified

Optionalfamily_name

family_name?: string

Surname or last name of the user

Optionalgender

gender?: string

User's gender

Optionalgenerate_password

generate_password?: boolean

Described wheter new password needs to be generated by the next login

Optionalgiven_name

given_name?: string

Given/first name of the user

Optionalgroups

groups?: UserGroupMap[]

List of groups of a user

OptionalidentityCustomFields

identityCustomFields?: any

Custom fileds for identity

OptionalidentityId

identityId?: string

the identityId identifying the useraccount and identity uniquely

Optionalinvite_id

invite_id?: string

id which is generated during user invitation process

Optionallocale

locale?: string

Preferred locale of the user

Optionalmfa_enabled

mfa_enabled?: boolean

Described whether multi factor authentication is enabled for the user

Optionalmiddle_name

middle_name?: string

Middle name of the user

Optionalmobile_number

mobile_number?: string

Mobile number of the user in string format

Optionalmobile_number_obj

mobile_number_obj?: UserMobile

Mobile number of the user as object

Optionalmobile_number_verified

mobile_number_verified?: boolean

Described whether user mobile number has been verified

Optionalneed_reset_password

need_reset_password?: boolean

Described whether password reset is needed

Optionalnickname

nickname?: string

Casual name of the user

OptionaloriginalProviderUserId

originalProviderUserId?: string[]

UserId from original provider. The value comes from custom/social provider to be referenced

Optionalpassword

password?: string

Password of a user

Optionalpassword_echo

password_echo?: string

Password confirm of a user

Optionalpassword_hash_info

password_hash_info?: any

Hash info of the password

Optionalphone_number

phone_number?: string

Phone number of the user in string format

Optionalphone_number_obj

phone_number_obj?: UserMobile

Phone number of the user as object

Optionalphone_number_verified

phone_number_verified?: boolean

Described whether user phone number has been verified

Optionalpicture

picture?: string

URL of the user's profile picture

Optionalprofile

profile?: string

URL of the user's profile page

Optionalprovider

provider?: string

Provider name indicating the origin of the social identity

OptionalproviderBusinessIds

providerBusinessIds?: string[]

List of BusinessId of provider. The value comes from custom/social provider to be referenced

OptionalproviderUserId

providerUserId?: string

User Id of provider. The value comes from custom/social provider to be referenced

OptionalrawJSON

rawJSON?: string

User information Json Object in String format

Optionalroles

roles?: string[]

List of roles of a user

Optionalstreet_address

street_address?: string

Street Address of a user

Optionalsub

sub?: string

Subject (User) identifier

OptionaltrackId

trackId?: string

Identifier generated after successful authentication but unfulfilled prechecks

Optionaluser_status_reason

user_status_reason?: string

Reason for user status

Optionalusername

username?: string

Username of the user

OptionaluserStatus

userStatus?: string

Status of User

Optionalwebsite

website?: string

URL of the user's web page or blog

Optionalzoneinfo

zoneinfo?: string

Represents the user's time zone

Settings

Member Visibility

On This Page

Properties