Class UpdateUserOptions

Hierarchy (View Summary)

Constructors

constructor

Properties

avatarUrl? clientId? email? firstName? id invitationStatus? is2faEnabled? isOtpEnabled? lastName? locale? otpSecret? password? phoneNumber? status? timezoneName? userToRoles?

Constructors

constructor

Properties

OptionalavatarUrl

avatarUrl?: string

User avatar URL

Example

'https://example.com/avatar.png'

OptionalclientId

clientId?: string

Client ID (for Apollo Studio)

Optionalemail

email?: string

User email address

Example

'[email protected]'

OptionalfirstName

firstName?: string

User first name

Example

'John'

id

id: string

OptionalinvitationStatus

invitationStatus?: UserInvitationStatus

User invitation status

See

UserInvitationStatus

Optionalis2faEnabled

is2faEnabled?: boolean

Is 2FA enabled for the user

OptionalisOtpEnabled

isOtpEnabled?: boolean

Is One-Time password enabled for the user

OptionallastName

lastName?: string

User last name

Example

'Doe'

Optionallocale

locale?: string

User locale code in ISO 639-1 (w letters) format

Example

'en'

OptionalotpSecret

otpSecret?: string

One-Time password secret. Used to generate OTP codes

Optionalpassword

password?: string

User password

Example

'qwerty'

OptionalphoneNumber

phoneNumber?: string

User phone number

Example

'+380501234567'

Optionalstatus

status?: UserStatus

User status

Example

'ACTIVE'

See

UserStatus

OptionaltimezoneName

timezoneName?: string

User timezone name

Example

'Europe/Kiev'

See

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

OptionaluserToRoles

userToRoles?: UpdateUserToRolesInput[]

User roles

Settings

Member Visibility

On This Page

Constructors
Properties