ListTenantsResult interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing the object returned from a TenantManager.listTenants() operation. Contains the list of tenants for the current batch and the next page token if available.
Signature:
export interface ListTenantsResult
Properties
| Property |
Type |
Description |
| pageToken |
string |
The next page token if available. This is needed for the next batch download. |
| tenants |
Tenant[] |
The list of Tenant objects for the downloaded batch. |
ListTenantsResult.pageToken
The next page token if available. This is needed for the next batch download.
Signature:
pageToken?: string;
ListTenantsResult.tenants
The list of Tenant objects for the downloaded batch.
Signature:
tenants: Tenant[];
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 [TenantManager.listTenants()](./firebase-admin.auth.tenantmanager.md#tenantmanagerlisttenants) operation. Contains the list of tenants for the current batch and the next page token if available.\n\n**Signature:** \n\n export interface ListTenantsResult \n\nProperties\n\nListTenantsResult.pageToken\n\nThe next page token if available. This is needed for the next batch download.\n\n**Signature:** \n\n pageToken?: string;\n\nListTenantsResult.tenants\n\nThe list of [Tenant](./firebase-admin.auth.tenant.md#tenant_class) objects for the downloaded batch.\n\n**Signature:** \n\n tenants: Tenant[];"]]
