Method: oauthClients.exchangeDebugToken
Stay organized with collections
Save and categorize content based on your preferences.
Validates a debug token secret that you have previously created using
CreateDebugToken
. If valid, returns an
AppCheckToken
.
Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.
HTTP request
POST https://firebaseappcheck.googleapis.com/v1/{app=oauthClients/*}:exchangeDebugToken
The URL uses
gRPC Transcoding
syntax.
Path parameters
Parameters
|
app
|
string
Required. The relative resource name of the app, in the format:
projects/{project_number}/apps/{app_id}
If necessary, the
project_number
element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's
AIP 2510
standard.
|
Request body
The request body contains data with the following structure:
JSON representation
|
{
"debugToken": string,
"limitedUse": boolean
}
|
Fields
|
debugToken
|
string
Required. A debug token secret. This string must match a debug token secret previously created using
CreateDebugToken
.
|
limitedUse
|
boolean
Specifies whether this attestation is for use in a
limited use
(
true
) or
session based
(
false
) context. To enable this attestation to be used with the
replay protection
feature, set this to
true
. The default value is
false
.
|
Response body
If successful, the response body contains an instance of
AppCheckToken
.
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 2024-09-26 UTC.
[null,null,["Last updated 2024-09-26 UTC."],[],[],null,["# Method: oauthClients.exchangeDebugToken\n\nValidates a debug token secret that you have previously created using\n`\n`[CreateDebugToken](/docs/reference/appcheck/rest/v1/projects.apps.debugTokens/create#google.firebase.appcheck.v1.ConfigService.CreateDebugToken)`\n`\n. If valid, returns an\n`\n`[AppCheckToken](/docs/reference/appcheck/rest/v1/AppCheckToken)`\n`\n.\n\n\nNote that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.\n\n### HTTP request\n\n\n`\nPOST https://firebaseappcheck.googleapis.com/v1/{app=oauthClients/*}:exchangeDebugToken\n`\n\n\nThe URL uses\n[gRPC Transcoding](https://google.aip.dev/127)\nsyntax.\n\n### Path parameters\n\n| Parameters ||\n|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` app ` | ` string ` Required. The relative resource name of the app, in the format: projects/{project_number}/apps/{app_id} If necessary, the ` project_number ` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard. |\n\n### Request body\n\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------|\n| ``` { \"debugToken\": string, \"limitedUse\": boolean } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` debugToken ` | ` string ` Required. A debug token secret. This string must match a debug token secret previously created using ` `[CreateDebugToken](/docs/reference/appcheck/rest/v1/projects.apps.debugTokens/create#google.firebase.appcheck.v1.ConfigService.CreateDebugToken)` ` . |\n| ` limitedUse ` | ` boolean ` Specifies whether this attestation is for use in a *limited use* ( ` true ` ) or *session based* ( ` false ` ) context. To enable this attestation to be used with the *replay protection* feature, set this to ` true ` . The default value is ` false ` . |\n\n### Response body\n\n\nIf successful, the response body contains an instance of\n`\n`[AppCheckToken](/docs/reference/appcheck/rest/v1/AppCheckToken)`\n`\n."]]