Class CreateUserOptions

Index

Constructors

Properties

avatarUrl? clientId? email firstName id? invitationStatus? lastName password? permissions? phoneNumber? status? type? userToRoles?

Constructors

constructor

new CreateUserOptions(): CreateUserOptions
Returns CreateUserOptions

Properties

`Optional`avatarUrl

avatarUrl?: MaybeNull<string>

User avatar url

Example

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

`Optional`clientId

clientId?: MaybeNull<string>

User client ID (for Apollo Studio)

email

email: string

User email

Example

'[email protected]'

firstName

firstName: string

User first name

Example

'John'

`Optional`id

id?: string

`Optional`invitationStatus

invitationStatus?: UserInvitationStatus

User invitation status

See

UserInvitationStatus

lastName

lastName: string

User last name

Example

'Doe'

`Optional`password

password?: MaybeNull<string>

User password

Example

'1q2w3e4r5t6y'

`Optional`permissions

permissions?: string[]

User custom permissions

`Optional`phoneNumber

phoneNumber?: MaybeNull<string>

User phone number

Example

'+1 123 456 7890'

`Optional`status

status?: UserStatus

User status

Example

'WAITING_FOR_APPROVAL'

See

UserStatus

`Optional`type

type?: UserType

User type. Can be either 'USET' or 'SA'

Example

'USER'

`Optional`userToRoles

userToRoles?: CreateUserToRolesOptions[]

User roles

Class CreateUserOptions

Index

Constructors

Properties

Constructors

constructor

Returns CreateUserOptions

Properties

`Optional`avatarUrl

Example

`Optional`clientId

email

Example

firstName

Example

`Optional`id

`Optional`invitationStatus

See

lastName

Example

`Optional`password

Example

`Optional`permissions

`Optional`phoneNumber

Example

`Optional`status

Example

See

`Optional`type

Example

`Optional`userToRoles

Settings

On This Page

Class CreateUserOptions

Index

Constructors

Properties

Constructors

constructor

Returns CreateUserOptions

Properties

OptionalavatarUrl

Example

OptionalclientId

email

Example

firstName

Example

Optionalid

OptionalinvitationStatus

See

lastName

Example

Optionalpassword

Example

Optionalpermissions

OptionalphoneNumber

Example

Optionalstatus

Example

See

Optionaltype

Example

OptionaluserToRoles

Settings

On This Page

`Optional`avatarUrl

`Optional`clientId

`Optional`id

`Optional`invitationStatus

`Optional`password

`Optional`permissions

`Optional`phoneNumber

`Optional`status

`Optional`type

`Optional`userToRoles