firebase_admin.credentials module

Firebase credentials module.

Classes

AccessTokenInfo

class firebase_admin.credentials.AccessTokenInfo(access_token, expiry)

Bases: tuple

Data included in an OAuth2 access token.

Contains the access token string and the expiry time. The expirty time is exposed as a datetime value.

access_token

Alias for field number 0

expiry

Alias for field number 1

ApplicationDefault

class firebase_admin.credentials.ApplicationDefault

Bases: Base

A Google Application Default credential.

get_credential()

Returns the underlying Google credential.

Raises:

google.auth.exceptions.DefaultCredentialsError – If Application Default credentials cannot be initialized in the current environment.

Returns:

A Google Auth credential instance.

Return type:

google.auth.credentials.Credentials

property project_id

Returns the project_id from the underlying Google credential.

Raises:

google.auth.exceptions.DefaultCredentialsError – If Application Default credentials cannot be initialized in the current environment.

Returns:

The project id.

Return type:

str

Base

class firebase_admin.credentials.Base

Bases: object

Provides OAuth2 access tokens for accessing Firebase services.

get_access_token()

Fetches a Google OAuth2 access token using this credential instance.

Returns:

An access token obtained using the credential.

Return type:

AccessTokenInfo

get_credential()

Returns the Google credential instance used for authentication.

Certificate

class firebase_admin.credentials.Certificate(cert)

Bases: Base

A credential initialized from a JSON certificate keyfile.

get_credential()

Returns the underlying Google credential.

Returns:

A Google Auth credential instance.

Return type:

google.auth.credentials.Credentials

property project_id
property service_account_email
property signer

RefreshToken

class firebase_admin.credentials.RefreshToken(refresh_token)

Bases: Base

A credential initialized from an existing refresh token.

get_credential()

Returns the underlying Google credential.

Returns:

A Google Auth credential instance.

Return type:

google.auth.credentials.Credentials

property client_id
property client_secret
property refresh_token