Class UsersResource

Operations for managing users within the organization. Accessed via AdminClient.users.

Index

Constructors

Methods

delete describe list

Constructors

constructor

new UsersResource(api: UsersApi): UsersResource
Parameters
- api: UsersApi
Returns UsersResource
- Defined in src/admin/resources/users.ts:21

Methods

delete

delete(userId: string): Promise<void>
Delete a user by ID, removing them from the organization.
Parameters
- userId: string
Returns Promise<void>
- Defined in src/admin/resources/users.ts:47

describe

describe(userId: string): Promise<User>
Get a user's details by ID.
Parameters
- userId: string
Returns Promise<User>
- Defined in src/admin/resources/users.ts:26

list

list(options?: ListUsersOptions): Promise<UserList>
List users in the organization, optionally filtered by email.
Parameters
- options: ListUsersOptions = {}
Returns Promise<UserList>
- Defined in src/admin/resources/users.ts:39