Interface that represents the OAuth credentials returned by an OAuth provider. Implementations specify the details about each auth provider's credential requirements.

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

Optional accessToken

accessToken: string

The OAuth access token associated with the credential if it belongs to an OAuth provider, such as facebook.com, twitter.com, etc.

Optional idToken

idToken: string

The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as google.com.

providerId

providerId: string

The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'.

Optional secret

secret: string

The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as twitter.com.

signInMethod

signInMethod: string

The authentication sign in method for the credential. For example, 'password', or 'emailLink. This corresponds to the sign-in method identifier as returned in firebase.auth.Auth.fetchSignInMethodsForEmail.

Methods

toJSON

  • toJSON ( ) : Object

  • Returns a JSON-serializable representation of this object.

    Returns Object

Static fromJSON

  • fromJSON ( json :  Object | string ) : AuthCredential | null

  • Static method to deserialize a JSON representation of an object into an firebase.auth.AuthCredential. Input can be either Object or the stringified representation of the object. When string is provided, JSON.parse would be called first. If the JSON input does not represent anAuthCredential, null is returned.

    Parameters

    • json: Object | string

      The plain object representation of an AuthCredential.

    Returns AuthCredential | null