listUsers()

listUsers(maxResults?, pageToken?): Promise<ListUsersResult>

Defined in: CloudFireAuth.ts:262

Retrieves a list of users (single batch only) with a size of maxResults starting from the offset as specified by pageToken. This is used to retrieve all the users of a specified project in batches.

See List all users for code samples and detailed documentation.

Parameters

maxResults?

number

The page size, 1000 if undefined. This is also the maximum allowed limit.

pageToken?

string

The next page token. If not specified, returns users starting without any offset.

Returns

Promise<ListUsersResult>

A promise that resolves with the current batch of downloaded users and the next page token.