Class User

Implements

User

Index

Constructors

Properties

emails id isPrimaryUser loginMethods phoneNumbers tenantIds thirdParty timeJoined webauthn

Methods

Constructors

constructor

new User(user: UserWithoutHelperFunctions): User
Parameters
- user: UserWithoutHelperFunctions
Returns User
- Defined in lib/ts/user.ts:109

Properties

`Readonly`emails

emails: string[]

`Readonly`id

id: string

`Readonly`isPrimaryUser

isPrimaryUser: boolean

`Readonly`loginMethods

loginMethods: LoginMethod[]

`Readonly`phoneNumbers

phoneNumbers: string[]

`Readonly`tenantIds

tenantIds: string[]

`Readonly`thirdParty

thirdParty: { id: string; userId: string }[]

`Readonly`timeJoined

timeJoined: number

`Readonly`webauthn

webauthn: { credentialIds: string[] }

Methods

toJson

toJson(): JSONObject
Returns JSONObject
Implementation of UserType.toJson
- Defined in lib/ts/user.ts:133

`Static`fromApi

fromApi(apiUser: Omit<UserWithoutHelperFunctions, "id"> & { id: string }): User
This function is used to create a User object from the API response.
Parameters
- apiUser: Omit<UserWithoutHelperFunctions, "id"> & { id: string }
  The API response from the user endpoint.
Returns User
A User object.
- Defined in lib/ts/user.ts:129