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

Index

Constructors

Private constructor

Properties

Optional accessToken

accessToken:string

The OAuth access token associated with the credential if it belongs toan OAuth provider, such asfacebook.com,twitter.com, etc.

Optional idToken

idToken:string

The OAuth ID token associated with the credential if it belongs to anOIDC provider, such asgoogle.com.

providerId

providerId:string

Inherited fromAuthCredential.providerId

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 itbelongs to an OAuth 1.0 provider, such astwitter.com.

signInMethod

signInMethod:string

Inherited fromAuthCredential.signInMethod

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

Methods

toJSON

Static fromJSON

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

  • Inherited fromAuthCredential.fromJSON

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

    Parameters

    • json:Object |string

      The plain object representation of anAuthCredential.

    ReturnsAuthCredential |null

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-27 UTC.