firebase-js-sdk/docs-devsite/auth.oauthcredentialoptions.md

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

OAuthCredentialOptions interface

Defines the options for initializing an OAuthCredential.

For ID tokens with nonce claim, the raw nonce has to also be provided.

Signature:

export interface OAuthCredentialOptions 

Properties

Property	Type	Description
accessToken	string	The OAuth access token used to initialize the OAuthCredential.
idToken	string	The OAuth ID token used to initialize the OAuthCredential.
rawNonce	string	The raw nonce associated with the ID token.

OAuthCredentialOptions.accessToken

The OAuth access token used to initialize the OAuthCredential.

Signature:

accessToken?: string;

OAuthCredentialOptions.idToken

The OAuth ID token used to initialize the OAuthCredential.

Signature:

idToken?: string;

OAuthCredentialOptions.rawNonce

The raw nonce associated with the ID token.

It is required when an ID token with a nonce field is provided. The SHA-256 hash of the raw nonce must match the nonce field in the ID token.

Signature:

rawNonce?: string;