firebase-admin-python の API リファレンス
firebase-admin-python (firebase/firebase-admin-python) の公開 API 84 件 —— クラス 65、関数 5、メソッド 14。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: firebase/firebase-admin-python
| 種別 | 件数 |
|---|---|
| クラス | 65 |
| 関数 | 5 |
| メソッド | 14 |
API 一覧
class
firebase_admin.AppThe entry point for Firebase Python SDK.
class
firebase_admin._auth_providers.OIDCProviderConfigRepresents the OIDC auth provider configuration.
class
firebase_admin._auth_providers.ProviderConfigParent type for all authentication provider config types.
class
firebase_admin._auth_providers.ProviderConfigClientClient for managing Auth provider configurations.
class
firebase_admin._auth_providers.SAMLProviderConfigRepresents he SAML auth provider configuration.
class
firebase_admin._auth_utils.EmailAlreadyExistsErrorThe user with the provided email already exists.
class
firebase_admin._auth_utils.EmailNotFoundErrorNo user record found for the specified email.
class
firebase_admin._auth_utils.InvalidIdTokenErrorThe provided ID token is not a valid Firebase ID token.
class
firebase_admin._auth_utils.ResetPasswordExceedLimitErrorReset password emails exceeded their limits.
class
firebase_admin._auth_utils.TenantNotFoundErrorNo tenant found for the specified identifier.
class
firebase_admin._auth_utils.TooManyAttemptsTryLaterErrorRate limited because of too many attempts.
class
firebase_admin._auth_utils.UidAlreadyExistsErrorThe user with the provided uid already exists.
class
firebase_admin._auth_utils.UserNotFoundErrorNo user record found for the specified identifier.
class
firebase_admin._http_client.GoogleAuthCredentialFlowGoogle Auth Credential Auth Flow
class
firebase_admin._http_client.HttpClientBase HTTP client used to make HTTP calls.
class
firebase_admin._http_client.JsonHttpClientAn HTTP client that parses response messages as JSON.
class
firebase_admin._messaging_utils.APNSPayloadPayload of an APNS message.
class
firebase_admin._messaging_utils.AndroidNotificationAndroid-specific notification parameters.
class
firebase_admin._messaging_utils.ApsAps dictionary to be included in an APNS payload.
class
firebase_admin._messaging_utils.ApsAlertAn alert that can be included in ``messaging.Aps``.
class
firebase_admin._messaging_utils.FCMOptionsOptions for features provided by SDK.
class
firebase_admin._messaging_utils.NotificationA notification that can be included in a message.
class
firebase_admin._messaging_utils.QuotaExceededErrorSending limit exceeded for the message target.
class
firebase_admin._messaging_utils.UnregisteredErrorApp instance was unregistered from FCM.
class
firebase_admin._messaging_utils.WebpushNotificationWebpush-specific notification parameters.
class
firebase_admin._retry.HttpxRetryHTTPX based retry config
method
firebase_admin._retry.HttpxRetry.copy() -> HttpxRetryCreates a deep copy of this instance.
method
firebase_admin._retry.HttpxRetry.is_exhausted() -> boolDetermine if there are anymore more retires.
class
firebase_admin._retry.HttpxRetryTransportHTTPX transport with retry logic.
class
firebase_admin._sseclient.EventEvent represents the events fired by SSE.
class
firebase_admin._sseclient.SSEClientSSE client implementation.
method
firebase_admin._sseclient.SSEClient.close()Closes the SSEClient instance.
class
firebase_admin._token_gen.ExpiredIdTokenErrorThe provided ID token is expired.
class
firebase_admin._token_gen.ExpiredSessionCookieErrorThe provided session cookie is expired.
class
firebase_admin._token_gen.RevokedIdTokenErrorThe provided ID token has been revoked.
class
firebase_admin._token_gen.RevokedSessionCookieErrorThe provided session cookie has been revoked.
class
firebase_admin._token_gen.TokenGeneratorGenerates custom tokens and session cookies.
class
firebase_admin._token_gen.TokenSignErrorUnexpected error while signing a Firebase custom token.
class
firebase_admin._token_gen.TokenVerifierVerifies ID tokens and session cookies.
class
firebase_admin._user_identifier.EmailIdentifierUsed for looking up an account by email.
class
firebase_admin._user_identifier.PhoneIdentifierUsed for looking up an account by phone number.
class
firebase_admin._user_identifier.ProviderIdentifierUsed for looking up an account by provider.
class
firebase_admin._user_identifier.UidIdentifierUsed for looking up an account by uid.
class
firebase_admin._user_identifier.UserIdentifierIdentifies a user to be looked up.
class
firebase_admin._user_mgt.GetUsersResultRepresents the result of the ``auth.get_users()`` API.
class
firebase_admin._user_mgt.UserInfoA collection of standard profile information for a user.
method
firebase_admin._user_mgt.UserInfo.uid()Returns the user ID of this user.
method
firebase_admin._user_mgt.UserRecord.uid()Returns the user ID of this user.
func
firebase_admin.app_check.verify_token(token:str, app=None) -> Dict[str, Any]Verifies a Firebase App Check token.
class
firebase_admin.credentials.ApplicationDefaultA Google Application Default credential.
class
firebase_admin.credentials.BaseProvides OAuth2 access tokens for accessing Firebase services.
method
firebase_admin.db.Event.data()Parsed JSON data of this event.
method
firebase_admin.db.Event.event_type()Event type string (put, patch).
method
firebase_admin.db.Reference.push(value='')Creates a new child node.
func
firebase_admin.delete_app(app)Gracefully deletes an App instance.
class
firebase_admin.exceptions.CancelledErrorRequest cancelled by the client.
class
firebase_admin.exceptions.DataLossErrorUnrecoverable data loss or data corruption.
class
firebase_admin.exceptions.DeadlineExceededErrorRequest deadline exceeded.
class
firebase_admin.exceptions.FirebaseErrorBase class for all errors raised by the Admin SDK.
class
firebase_admin.exceptions.InternalErrorInternal server error.
class
firebase_admin.exceptions.InvalidArgumentErrorClient specified an invalid argument.
class
firebase_admin.exceptions.OutOfRangeErrorClient specified an invalid range.
class
firebase_admin.exceptions.PermissionDeniedErrorClient does not have sufficient permission.
class
firebase_admin.exceptions.ResourceExhaustedErrorEither out of resource quota or reaching rate limiting.
class
firebase_admin.exceptions.UnavailableErrorService unavailable.
class
firebase_admin.exceptions.UnknownErrorUnknown server error.
class
firebase_admin.functions.ResourceContains the parsed address of a resource.
class
firebase_admin.functions.TaskOptionsTask Options that can be applied to a Task.
func
firebase_admin.get_app(name=_DEFAULT_APP_NAME)Retrieves an App instance by name.
class
firebase_admin.ml.ListModelsPageRepresents a page of models in a Firebase project.
method
firebase_admin.ml.ListModelsPage.models()A list of Models from this page.
class
firebase_admin.ml.ModelA Firebase ML Model object.
method
firebase_admin.ml.Model.create_time()The time the model was created.
method
firebase_admin.ml.Model.from_dict(data, app=None)Create an instance of the object from a dict.
method
firebase_admin.ml.Model.model_hash()SHA256 hash of the model binary.
method
firebase_admin.ml.Model.validation_error()Validation error message.
class
firebase_admin.ml.TFLiteFormatModel format representing a TFLite model.
method
firebase_admin.ml.TFLiteFormat.model_source()The TF Lite model's location.
func
firebase_admin.ml.publish_model(model_id, app=None)Publishes a Firebase ML model.
class
firebase_admin.project_management.IOSAppA reference to an iOS app within a Firebase project.
class
firebase_admin.project_management.IOSAppMetadataiOS-specific information about an iOS Firebase app.
class
firebase_admin.remote_config.ServerConfigRepresents a Remote Config Server Side Config.
class
firebase_admin.tenant_mgt.TenantRepresents a tenant in a multi-tenant application.
func
integration.emulators.functions.main.testTaskQueue(req:tasks_fn.CallableRequest) -> NoneHandles tasks from the task queue.
この情報について
掲載しているシグネチャは firebase/firebase-admin-python の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。