ListUsersResult interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing the object returned from a BaseAuth.listUsers() operation. Contains the list of users for the current batch and the next page token if available.
Signature:
export interface ListUsersResult
Properties
| Property |
Type |
Description |
| pageToken |
string |
The next page token if available. This is needed for the next batch download. |
| users |
UserRecord[] |
The list of UserRecord objects for the current downloaded batch. |
ListUsersResult.pageToken
The next page token if available. This is needed for the next batch download.
Signature:
pageToken?: string;
ListUsersResult.users
The list of UserRecord objects for the current downloaded batch.
Signature:
users: UserRecord[];
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["Interface representing the object returned from a [BaseAuth.listUsers()](./firebase-admin.auth.baseauth.md#baseauthlistusers) operation. Contains the list of users for the current batch and the next page token if available.\n\n**Signature:** \n\n export interface ListUsersResult \n\nProperties\n\nListUsersResult.pageToken\n\nThe next page token if available. This is needed for the next batch download.\n\n**Signature:** \n\n pageToken?: string;\n\nListUsersResult.users\n\nThe list of [UserRecord](./firebase-admin.auth.userrecord.md#userrecord_class) objects for the current downloaded batch.\n\n**Signature:** \n\n users: UserRecord[];"]]
