OAuthResponseType interface
Stay organized with collections
Save and categorize content based on your preferences.
The interface representing OIDC provider's response object for OAuth authorization flow. One of the following settings is required:
- Set
code
to true
for the code flow. - Set
idToken
to true
for the ID token flow.
Signature:
export interface OAuthResponseType
Properties
Property |
Type |
Description |
code |
boolean |
Whether authorization code is returned from IdP's authorization endpoint. |
idToken |
boolean |
Whether ID token is returned from IdP's authorization endpoint. |
OAuthResponseType.code
Whether authorization code is returned from IdP's authorization endpoint.
Signature:
code?: boolean;
OAuthResponseType.idToken
Whether ID token is returned from IdP's authorization endpoint.
Signature:
idToken?: boolean;
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-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["# OAuthResponseType interface\n\nThe interface representing OIDC provider's response object for OAuth authorization flow. One of the following settings is required:\n\n- Set `code` to `true` for the code flow.\n- Set `idToken` to `true` for the ID token flow.\n\n\u003cbr /\u003e\n\n**Signature:** \n\n export interface OAuthResponseType \n\nProperties\n----------\n\n| Property | Type | Description |\n|--------------------------------------------------------------------------------|---------|---------------------------------------------------------------------------|\n| [code](./firebase-admin.auth.oauthresponsetype.md#oauthresponsetypecode) | boolean | Whether authorization code is returned from IdP's authorization endpoint. |\n| [idToken](./firebase-admin.auth.oauthresponsetype.md#oauthresponsetypeidtoken) | boolean | Whether ID token is returned from IdP's authorization endpoint. |\n\nOAuthResponseType.code\n----------------------\n\nWhether authorization code is returned from IdP's authorization endpoint.\n\n**Signature:** \n\n code?: boolean;\n\nOAuthResponseType.idToken\n-------------------------\n\nWhether ID token is returned from IdP's authorization endpoint.\n\n**Signature:** \n\n idToken?: boolean;"]]