Method: projects.apps.generateAppAttestChallenge
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://firebaseappcheck.googleapis.com/v1beta/{app=projects/*/apps/*}: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.
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-04-05 UTC.
[null,null,["Last updated 2024-04-05 UTC."],[],[],null,["# Method: projects.apps.generateAppAttestChallenge\n\nGenerates a challenge that protects the integrity of an immediately following call to [apps.exchangeAppAttestAttestation](/docs/reference/appcheck/rest/v1beta/projects.apps/exchangeAppAttestAttestation#google.firebase.appcheck.v1beta.TokenExchangeService.ExchangeAppAttestAttestation) or [apps.exchangeAppAttestAssertion](/docs/reference/appcheck/rest/v1beta/projects.apps/exchangeAppAttestAssertion#google.firebase.appcheck.v1beta.TokenExchangeService.ExchangeAppAttestAssertion). A challenge should not be reused for multiple calls.\n\n### HTTP request\n\n`POST https://firebaseappcheck.googleapis.com/v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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](https://google.aip.dev/cloud/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](https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [GenerateAppAttestChallengeResponse](/docs/reference/appcheck/rest/v1beta/GenerateAppAttestChallengeResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `https://www.googleapis.com/auth/firebase`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]