Method: oauthClients.generateAppAttestChallenge

Generates a challenge that protects the integrity of an immediately following call to oauthClients.exchangeAppAttestAttestation or oauthClients.exchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

HTTP request

POST https://firebaseappcheck.googleapis.com/v1beta/{app=oauthClients/*}:generateAppAttestChallenge

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
app

string

Required. The relative resource name of the iOS 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 must be empty.

Response body

If successful, the response body contains an instance of GenerateAppAttestChallengeResponse.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

For more information, see the Authentication Overview.