Stay organized with collections
Save and categorize content based on your preferences.
Properties
Optional accessToken
accessToken: string
Optional idToken
idToken: string
providerId
providerId: string
Optional secret
secret: string
signInMethod
signInMethod: string
Methods
toJSON
- toJSON
(
)
:
Object
-
Returns Object
Static fromJSON
- fromJSON
(
json
:
Object
|
string
)
:
AuthCredential
|
null
-
Parameters
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-27 UTC.
[null,null,["Last updated 2022-07-27 UTC."],[],[],null,["- [firebase](/docs/reference/node/firebase).\n- [auth](/docs/reference/node/firebase.auth).\n- OAuthCredential \nInterface that represents the OAuth credentials returned by an OAuth\nprovider. Implementations specify the details about each auth provider's\ncredential requirements.\n\nIndex\n\nConstructors\n\n- [constructor](/docs/reference/node/firebase.auth.OAuthCredential#constructor)\n\nProperties\n\n- [accessToken](/docs/reference/node/firebase.auth.OAuthCredential#accesstoken)\n- [idToken](/docs/reference/node/firebase.auth.OAuthCredential#idtoken)\n- [providerId](/docs/reference/node/firebase.auth.OAuthCredential#providerid)\n- [secret](/docs/reference/node/firebase.auth.OAuthCredential#secret)\n- [signInMethod](/docs/reference/node/firebase.auth.OAuthCredential#signinmethod)\n\nMethods\n\n- [toJSON](/docs/reference/node/firebase.auth.OAuthCredential#tojson)\n- [fromJSON](/docs/reference/node/firebase.auth.OAuthCredential#fromjson)\n\nConstructors\n\nPrivate constructor\n\n- new OAuthCredential ( ) : [OAuthCredential](/docs/reference/node/firebase.auth.OAuthCredential)\n-\n\n Returns [OAuthCredential](/docs/reference/node/firebase.auth.OAuthCredential)\n\nProperties\n\nOptional accessToken \naccessToken: string \nThe OAuth access token associated with the credential if it belongs to\nan OAuth provider, such as `facebook.com`, `twitter.com`, etc.\n\nOptional idToken \nidToken: string \nThe OAuth ID token associated with the credential if it belongs to an\nOIDC provider, such as `google.com`.\n\nproviderId \nproviderId: string\nInherited from [AuthCredential](/docs/reference/node/firebase.auth.AuthCredential).[providerId](/docs/reference/node/firebase.auth.AuthCredential#providerid) \nThe authentication provider ID for the credential.\nFor example, 'facebook.com', or 'google.com'.\n\nOptional secret \nsecret: string \nThe OAuth access token secret associated with the credential if it\nbelongs to an OAuth 1.0 provider, such as `twitter.com`.\n\nsignInMethod \nsignInMethod: string\nInherited from [AuthCredential](/docs/reference/node/firebase.auth.AuthCredential).[signInMethod](/docs/reference/node/firebase.auth.AuthCredential#signinmethod) \nThe authentication sign in method for the credential.\nFor example, 'password', or 'emailLink. This corresponds to the sign-in\nmethod identifier as returned in\n[firebase.auth.Auth.fetchSignInMethodsForEmail](/docs/reference/node/firebase.auth.Auth#fetchsigninmethodsforemail).\n\nMethods\n\ntoJSON\n\n- toJSON ( ) : Object\n-\n Inherited from [AuthCredential](/docs/reference/node/firebase.auth.AuthCredential).[toJSON](/docs/reference/node/firebase.auth.AuthCredential#tojson) \n Returns a JSON-serializable representation of this object.\n\n Returns Object\n\nStatic fromJSON\n\n- fromJSON ( json : Object \\| string ) : [AuthCredential](/docs/reference/node/firebase.auth.AuthCredential) \\| null\n-\n Inherited from [AuthCredential](/docs/reference/node/firebase.auth.AuthCredential).[fromJSON](/docs/reference/node/firebase.auth.AuthCredential#fromjson) \n Static method to deserialize a JSON representation of an object into an\n [firebase.auth.AuthCredential](/docs/reference/node/firebase.auth.AuthCredential). Input can be either Object or the\n stringified representation of the object. When string is provided,\n JSON.parse would be called first. If the JSON input does not represent\n an`AuthCredential`, null is returned.\n\n Parameters\n -\n\n json: Object \\| string \n The plain object representation of an\n AuthCredential.\n\nReturns [AuthCredential](/docs/reference/node/firebase.auth.AuthCredential) \\| null"]]
Interface that represents the OAuth credentials returned by an OAuth provider. Implementations specify the details about each auth provider's credential requirements.