Skip to content

UserMethods

Methods attached to user objects returned by getById() and create().

Methods

delete()

delete(): Promise<void>

Deletes this user.

Returns

Promise<void>

Promise that resolves when the user is deleted


update()

update(options: UserUpdateOptions): Promise<UserUpdateResponse>

Updates this user. Only the provided fields are changed.

Parameters

Parameter Type Description
options UserUpdateOptions Fields to update

Returns

Promise<UserUpdateResponse>

Promise resolving to the operation outcome