Skip to Content

AdminClient

A client for the admin API, created with createAdminClient. Each property is one resource; Methods return resource values or throw ApiClientError or ApiClientUsageError. Each method sends one request unless its documentation says otherwise.

Project-scoped methods take the project id first, so one client works across projects concurrently. Every resource id is a UUID; an id that is not one is rejected before a request is sent.

Constructors

Constructor

protected new AdminClient(config): AdminClient;

Use createAdminClient.

Parameters

config

CreateAdminClientConfig

Properties

apiKeys

readonly apiKeys: ApiKeysResource;

backups

readonly backups: BackupsResource;

customers

readonly customers: CustomersResource;

externalBillingProviders

readonly externalBillingProviders: ExternalBillingProvidersResource;

externalServiceAccounts

readonly externalServiceAccounts: ExternalServiceAccountsResource;

firebaseLifecycle

readonly firebaseLifecycle: FirebaseLifecycleResource;

logs

readonly logs: LogsResource;

models

readonly models: ModelsResource;

productGrants

readonly productGrants: ProductGrantsResource;

products

readonly products: ProductsResource;

projects

readonly projects: ProjectsResource;

rateLimitRules

readonly rateLimitRules: RateLimitRulesResource;

secretsIntegrations

readonly secretsIntegrations: SecretsIntegrationsResource;

starredItems

readonly starredItems: StarredItemsResource;

subscriptionRelays

readonly subscriptionRelays: SubscriptionRelaysResource;

subscriptionSignIns

readonly subscriptionSignIns: SubscriptionSignInsResource;

usageLimitRules

readonly usageLimitRules: UsageLimitRulesResource;

Workflow guides

Last updated on