GetUsersResult interface
Stay organized with collections
Save and categorize content based on your preferences.
Represents the result of the BaseAuth.getUsers() API.
Signature:
export interface GetUsersResult
Properties
| Property |
Type |
Description |
| notFound |
UserIdentifier[] |
Set of identifiers that were requested, but not found. |
| users |
UserRecord[] |
Set of user records, corresponding to the set of users that were requested. Only users that were found are listed here. The result set is unordered. |
GetUsersResult.notFound
Set of identifiers that were requested, but not found.
Signature:
notFound: UserIdentifier[];
GetUsersResult.users
Set of user records, corresponding to the set of users that were requested. Only users that were found are listed here. The result set is unordered.
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,["# GetUsersResult interface\n\nRepresents the result of the [BaseAuth.getUsers()](./firebase-admin.auth.baseauth.md#baseauthgetusers) API.\n\n**Signature:** \n\n export interface GetUsersResult \n\nProperties\n----------\n\n| Property | Type | Description |\n|----------------------------------------------------------------------------|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [notFound](./firebase-admin.auth.getusersresult.md#getusersresultnotfound) | [UserIdentifier](./firebase-admin.auth.md#useridentifier)\\[\\] | Set of identifiers that were requested, but not found. |\n| [users](./firebase-admin.auth.getusersresult.md#getusersresultusers) | [UserRecord](./firebase-admin.auth.userrecord.md#userrecord_class)\\[\\] | Set of user records, corresponding to the set of users that were requested. Only users that were found are listed here. The result set is unordered. |\n\nGetUsersResult.notFound\n-----------------------\n\nSet of identifiers that were requested, but not found.\n\n**Signature:** \n\n notFound: UserIdentifier[];\n\nGetUsersResult.users\n--------------------\n\nSet of user records, corresponding to the set of users that were requested. Only users that were found are listed here. The result set is unordered.\n\n**Signature:** \n\n users: UserRecord[];"]]
