2024-05-31
▼ ▲ firebaseappcheck.oauthClients.exchangeAppAttestAttestation
Scopes:
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).
Path: v1/{+app}:exchangeAppAttestAttestation
Flat Path: v1/oauthClients/{oauthClientsId}:exchangeAppAttestAttestation
HTTP Method: POST
Parameter Order: app
Parameters:
app
Pattern: ^oauthClients/[^/]+$
Location: path
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.
Required: Yes
Type: string
▼ ▲ firebaseappcheck.oauthClients.exchangeAppAttestAssertion
HTTP Method: POST
Description: Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.
Parameter Order: app
Path: v1/{+app}:exchangeAppAttestAssertion
Parameters:
app
Location: path
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.
Pattern: ^oauthClients/[^/]+$
Type: string
Required: Yes
Scopes:
Flat Path: v1/oauthClients/{oauthClientsId}:exchangeAppAttestAssertion
▼ ▲ firebaseappcheck.oauthClients.generateAppAttestChallenge
Flat Path: v1/oauthClients/{oauthClientsId}:generateAppAttestChallenge
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.
Parameter Order: app
Path: v1/{+app}:generateAppAttestChallenge
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
Required: Yes
Pattern: ^oauthClients/[^/]+$
HTTP Method: POST
Scopes:
▼ ▲ firebaseappcheck.oauthClients.exchangeDebugToken
Flat Path: v1/oauthClients/{oauthClientsId}:exchangeDebugToken
Parameter Order: app
Scopes:
HTTP Method: POST
Description: 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.
Path: v1/{+app}:exchangeDebugToken
Parameters:
app
Type: string
Pattern: ^oauthClients/[^/]+$
Required: Yes
Description: 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.
Location: path