ไปที่คอนโซล

firebase_admin.auth module

Firebase Authentication module.

This module contains functions for minting and verifying JWTs used for authenticating against Firebase services. It also provides functions for creating and managing user accounts in Firebase projects.

Exceptions

exception firebase_admin.auth.CertificateFetchError(message, cause)

Bases: firebase_admin.exceptions.UnknownError

Failed to fetch some public key certificates required to verify a token.

exception firebase_admin.auth.EmailAlreadyExistsError(message, cause, http_response)

Bases: firebase_admin.exceptions.AlreadyExistsError

The user with the provided email already exists.

default_message = 'The user with the provided email already exists'
exception firebase_admin.auth.ExpiredIdTokenError(message, cause)

Bases: firebase_admin._auth_utils.InvalidIdTokenError

The provided ID token is expired.

exception firebase_admin.auth.ExpiredSessionCookieError(message, cause)

Bases: firebase_admin._token_gen.InvalidSessionCookieError

The provided session cookie is expired.

exception firebase_admin.auth.InsufficientPermissionError(message, cause, http_response)

Bases: firebase_admin.exceptions.PermissionDeniedError

The credential used to initialize the SDK lacks required permissions.

default_message = 'The credential used to initialize the SDK has insufficient permissions to perform the requested operation. See https://firebase.google.com/docs/admin/setup for details on how to initialize the Admin SDK with appropriate permissions'
exception firebase_admin.auth.InvalidDynamicLinkDomainError(message, cause, http_response)

Bases: firebase_admin.exceptions.InvalidArgumentError

Dynamic link domain in ActionCodeSettings is not authorized.

default_message = 'Dynamic link domain specified in ActionCodeSettings is not authorized'
exception firebase_admin.auth.InvalidIdTokenError(message, cause=None, http_response=None)

Bases: firebase_admin.exceptions.InvalidArgumentError

The provided ID token is not a valid Firebase ID token.

default_message = 'The provided ID token is invalid'
exception firebase_admin.auth.InvalidSessionCookieError(message, cause=None)

Bases: firebase_admin.exceptions.InvalidArgumentError

The provided string is not a valid Firebase session cookie.

exception firebase_admin.auth.PhoneNumberAlreadyExistsError(message, cause, http_response)

Bases: firebase_admin.exceptions.AlreadyExistsError

The user with the provided phone number already exists.

default_message = 'The user with the provided phone number already exists'
exception firebase_admin.auth.RevokedIdTokenError(message)

Bases: firebase_admin._auth_utils.InvalidIdTokenError

The provided ID token has been revoked.

exception firebase_admin.auth.RevokedSessionCookieError(message)

Bases: firebase_admin._token_gen.InvalidSessionCookieError

The provided session cookie has been revoked.

exception firebase_admin.auth.TokenSignError(message, cause)

Bases: firebase_admin.exceptions.UnknownError

Unexpected error while signing a Firebase custom token.

exception firebase_admin.auth.UidAlreadyExistsError(message, cause, http_response)

Bases: firebase_admin.exceptions.AlreadyExistsError

The user with the provided uid already exists.

default_message = 'The user with the provided uid already exists'
exception firebase_admin.auth.UnexpectedResponseError(message, cause=None, http_response=None)

Bases: firebase_admin.exceptions.UnknownError

Backend service responded with an unexpected or malformed response.

exception firebase_admin.auth.UserNotFoundError(message, cause=None, http_response=None)

Bases: firebase_admin.exceptions.NotFoundError

No user record found for the specified identifier.

default_message = 'No user record found for the given identifier'

Classes

class firebase_admin.auth.ActionCodeSettings(url, handle_code_in_app=None, dynamic_link_domain=None, ios_bundle_id=None, android_package_name=None, android_install_app=None, android_minimum_version=None)

Bases: object

Contains required continue/state URL with optional Android and iOS settings. Used when invoking the email action link generation APIs.

class firebase_admin.auth.ErrorInfo(error)

Bases: object

Represents an error encountered while importing an ImportUserRecord.

index
reason