sdkagent

firebase-admin-python API reference

84 public APIs from firebase-admin-python (firebase/firebase-admin-python) — 65 classes, 5 functions, 14 methods. Signatures extracted by static analysis of the actual source.

Repository: firebase/firebase-admin-python

KindCount
Classes65
Functions5
Methods14

API list

classfirebase_admin.App
The entry point for Firebase Python SDK.
classfirebase_admin._auth_providers.OIDCProviderConfig
Represents the OIDC auth provider configuration.
classfirebase_admin._auth_providers.ProviderConfig
Parent type for all authentication provider config types.
classfirebase_admin._auth_providers.ProviderConfigClient
Client for managing Auth provider configurations.
classfirebase_admin._auth_providers.SAMLProviderConfig
Represents he SAML auth provider configuration.
classfirebase_admin._auth_utils.EmailAlreadyExistsError
The user with the provided email already exists.
classfirebase_admin._auth_utils.EmailNotFoundError
No user record found for the specified email.
classfirebase_admin._auth_utils.InvalidIdTokenError
The provided ID token is not a valid Firebase ID token.
classfirebase_admin._auth_utils.ResetPasswordExceedLimitError
Reset password emails exceeded their limits.
classfirebase_admin._auth_utils.TenantNotFoundError
No tenant found for the specified identifier.
classfirebase_admin._auth_utils.TooManyAttemptsTryLaterError
Rate limited because of too many attempts.
classfirebase_admin._auth_utils.UidAlreadyExistsError
The user with the provided uid already exists.
classfirebase_admin._auth_utils.UserNotFoundError
No user record found for the specified identifier.
classfirebase_admin._http_client.GoogleAuthCredentialFlow
Google Auth Credential Auth Flow
classfirebase_admin._http_client.HttpClient
Base HTTP client used to make HTTP calls.
classfirebase_admin._http_client.JsonHttpClient
An HTTP client that parses response messages as JSON.
classfirebase_admin._messaging_utils.APNSPayload
Payload of an APNS message.
classfirebase_admin._messaging_utils.AndroidNotification
Android-specific notification parameters.
classfirebase_admin._messaging_utils.Aps
Aps dictionary to be included in an APNS payload.
classfirebase_admin._messaging_utils.ApsAlert
An alert that can be included in ``messaging.Aps``.
classfirebase_admin._messaging_utils.FCMOptions
Options for features provided by SDK.
classfirebase_admin._messaging_utils.Notification
A notification that can be included in a message.
classfirebase_admin._messaging_utils.QuotaExceededError
Sending limit exceeded for the message target.
classfirebase_admin._messaging_utils.UnregisteredError
App instance was unregistered from FCM.
classfirebase_admin._messaging_utils.WebpushNotification
Webpush-specific notification parameters.
classfirebase_admin._retry.HttpxRetry
HTTPX based retry config
methodfirebase_admin._retry.HttpxRetry.copy() -> HttpxRetry
Creates a deep copy of this instance.
methodfirebase_admin._retry.HttpxRetry.is_exhausted() -> bool
Determine if there are anymore more retires.
classfirebase_admin._retry.HttpxRetryTransport
HTTPX transport with retry logic.
classfirebase_admin._sseclient.Event
Event represents the events fired by SSE.
classfirebase_admin._sseclient.SSEClient
SSE client implementation.
methodfirebase_admin._sseclient.SSEClient.close()
Closes the SSEClient instance.
classfirebase_admin._token_gen.ExpiredIdTokenError
The provided ID token is expired.
classfirebase_admin._token_gen.ExpiredSessionCookieError
The provided session cookie is expired.
classfirebase_admin._token_gen.RevokedIdTokenError
The provided ID token has been revoked.
classfirebase_admin._token_gen.RevokedSessionCookieError
The provided session cookie has been revoked.
classfirebase_admin._token_gen.TokenGenerator
Generates custom tokens and session cookies.
classfirebase_admin._token_gen.TokenSignError
Unexpected error while signing a Firebase custom token.
classfirebase_admin._token_gen.TokenVerifier
Verifies ID tokens and session cookies.
classfirebase_admin._user_identifier.EmailIdentifier
Used for looking up an account by email.
classfirebase_admin._user_identifier.PhoneIdentifier
Used for looking up an account by phone number.
classfirebase_admin._user_identifier.ProviderIdentifier
Used for looking up an account by provider.
classfirebase_admin._user_identifier.UidIdentifier
Used for looking up an account by uid.
classfirebase_admin._user_identifier.UserIdentifier
Identifies a user to be looked up.
classfirebase_admin._user_mgt.GetUsersResult
Represents the result of the ``auth.get_users()`` API.
classfirebase_admin._user_mgt.UserInfo
A collection of standard profile information for a user.
methodfirebase_admin._user_mgt.UserInfo.uid()
Returns the user ID of this user.
methodfirebase_admin._user_mgt.UserRecord.uid()
Returns the user ID of this user.
funcfirebase_admin.app_check.verify_token(token:str, app=None) -> Dict[str, Any]
Verifies a Firebase App Check token.
classfirebase_admin.credentials.ApplicationDefault
A Google Application Default credential.
classfirebase_admin.credentials.Base
Provides OAuth2 access tokens for accessing Firebase services.
methodfirebase_admin.db.Event.data()
Parsed JSON data of this event.
methodfirebase_admin.db.Event.event_type()
Event type string (put, patch).
methodfirebase_admin.db.Reference.push(value='')
Creates a new child node.
funcfirebase_admin.delete_app(app)
Gracefully deletes an App instance.
classfirebase_admin.exceptions.CancelledError
Request cancelled by the client.
classfirebase_admin.exceptions.DataLossError
Unrecoverable data loss or data corruption.
classfirebase_admin.exceptions.DeadlineExceededError
Request deadline exceeded.
classfirebase_admin.exceptions.FirebaseError
Base class for all errors raised by the Admin SDK.
classfirebase_admin.exceptions.InternalError
Internal server error.
classfirebase_admin.exceptions.InvalidArgumentError
Client specified an invalid argument.
classfirebase_admin.exceptions.OutOfRangeError
Client specified an invalid range.
classfirebase_admin.exceptions.PermissionDeniedError
Client does not have sufficient permission.
classfirebase_admin.exceptions.ResourceExhaustedError
Either out of resource quota or reaching rate limiting.
classfirebase_admin.exceptions.UnavailableError
Service unavailable.
classfirebase_admin.exceptions.UnknownError
Unknown server error.
classfirebase_admin.functions.Resource
Contains the parsed address of a resource.
classfirebase_admin.functions.TaskOptions
Task Options that can be applied to a Task.
funcfirebase_admin.get_app(name=_DEFAULT_APP_NAME)
Retrieves an App instance by name.
classfirebase_admin.ml.ListModelsPage
Represents a page of models in a Firebase project.
methodfirebase_admin.ml.ListModelsPage.models()
A list of Models from this page.
classfirebase_admin.ml.Model
A Firebase ML Model object.
methodfirebase_admin.ml.Model.create_time()
The time the model was created.
methodfirebase_admin.ml.Model.from_dict(data, app=None)
Create an instance of the object from a dict.
methodfirebase_admin.ml.Model.model_hash()
SHA256 hash of the model binary.
methodfirebase_admin.ml.Model.validation_error()
Validation error message.
classfirebase_admin.ml.TFLiteFormat
Model format representing a TFLite model.
methodfirebase_admin.ml.TFLiteFormat.model_source()
The TF Lite model's location.
funcfirebase_admin.ml.publish_model(model_id, app=None)
Publishes a Firebase ML model.
classfirebase_admin.project_management.IOSApp
A reference to an iOS app within a Firebase project.
classfirebase_admin.project_management.IOSAppMetadata
iOS-specific information about an iOS Firebase app.
classfirebase_admin.remote_config.ServerConfig
Represents a Remote Config Server Side Config.
classfirebase_admin.tenant_mgt.Tenant
Represents a tenant in a multi-tenant application.
funcintegration.emulators.functions.main.testTaskQueue(req:tasks_fn.CallableRequest) -> None
Handles tasks from the task queue.

About this data

These signatures were extracted from the public source of firebase/firebase-admin-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries