Method: projects.apps.exchangeDebugToken

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/v1beta/{app=projects/*/apps/*}: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.

Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: 

oauthClients/{oauth_client_id}

You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation for more information.

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 .