2023-06-02
▼ ▲ firebaseappcheck.oauthClients.generateAppAttestChallenge
Path: v1beta/{+app}:generateAppAttestChallenge
Parameter Order: app
Flat Path: v1beta/oauthClients/{oauthClientsId}:generateAppAttestChallenge
Scopes:
Description: Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.
Parameters:
app
Type: string
Description: 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.
Location: path
Pattern: ^oauthClients/[^/]+$
Required: Yes
HTTP Method: POST
▼ ▲ firebaseappcheck.oauthClients.exchangeAppAttestAssertion
Parameters:
app
Required: Yes
Pattern: ^oauthClients/[^/]+$
Description: 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.
Type: string
Location: path
Path: v1beta/{+app}:exchangeAppAttestAssertion
Description: Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.
Flat Path: v1beta/oauthClients/{oauthClientsId}:exchangeAppAttestAssertion
HTTP Method: POST
Scopes:
Parameter Order: app
▼ ▲ firebaseappcheck.oauthClients.exchangeAppAttestAttestation
Description: Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful).
Scopes:
Parameters:
app
Required: Yes
Pattern: ^oauthClients/[^/]+$
Description: 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.
Location: path
Type: string
HTTP Method: POST
Parameter Order: app
Path: v1beta/{+app}:exchangeAppAttestAttestation
Flat Path: v1beta/oauthClients/{oauthClientsId}:exchangeAppAttestAttestation