Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UserInfoResponse

Hierarchy

  • UserInfoResponse

Index

Properties

AccountId

AccountId: number

The ID of the default account with which the user is associated.

type

{number}

memberof

UserInfoResponse

AffiliatedId

AffiliatedId: number

The ID of an affiliated organization, if the user comes from an affiliated link. This is set to 0 if the user it not associated with an affiliated organization.

type

{number}

memberof

UserInfoResponse

DateTimeCreated

DateTimeCreated: number

The date and time at which this user record was created, in ISO 8601 format.

type

{number}

memberof

UserInfoResponse

Email

Email: string

Email address of the user; “person@company.com”.

type

{string}

memberof

UserInfoResponse

EmailVerified

EmailVerified: boolean

Has your organization verified this email as correct and operational? True if yes; false if no. Defaults to false.

type

{boolean}

memberof

UserInfoResponse

OMSId

OMSId: number

The ID of the Order Management System with which the user is associated.

type

{number}

memberof

UserInfoResponse

PasswordHash

PasswordHash: string

Not currently used. Returns an empty string.

type

{string}

memberof

UserInfoResponse

PendingCodeTime

PendingCodeTime: number

A date and time in ISO 8601 format. Reserved.

type

{number}

memberof

UserInfoResponse

PendingEmailCode

PendingEmailCode: string

Usually contains an empty string. Contains a GUID — a globally unique ID string — during the time that a new user has been sent a registration email and before the user clicks the confirmation link.

type

{string}

memberof

UserInfoResponse

RefererId

RefererId: number

Captures the ID of the person who referred this account member to the trading venue, usually for marketing purposes. Returns 0 if no referrer.

type

{number}

memberof

UserInfoResponse

Salt

Salt: string

Reserved for future use. Currently returns an empty string

type

{string}

memberof

UserInfoResponse

Use2FA

Use2FA: boolean

True if the user must use two-factor authentication; false if the user does not need to use two-factor authentication. Defaults to false.

type

{boolean}

memberof

UserInfoResponse

UserId

UserId: number

ID number of the user whose information is being set.

type

{number}

memberof

UserInfoResponse

UserName

UserName: string

Log-in name of the user; “jsmith”

type

{string}

memberof

UserInfoResponse

Generated using TypeDoc