Firebase App Check API (firebaseappcheck:v1beta)

Deletions

Methods


• ▼ ▲ firebaseappcheck.projects.apps.generatePlayIntegrityChallenge

  Flat Path: v1beta/projects/{projectsId}/apps/{appsId}:generatePlayIntegrityChallenge

  Parameters:

  app

  Type: string

  Required: Yes

  Location: path

  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.

  Pattern: ^projects/[^/]+/apps/[^/]+$

  Parameter Order: app

  Description: Generates a challenge that protects the integrity of an immediately following integrity verdict request to the Play Integrity API. The next call to ExchangePlayIntegrityToken using the resulting integrity token will verify the presence and validity of the challenge. A challenge should not be reused for multiple calls.

  Scopes:

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

  Path: v1beta/{+app}:generatePlayIntegrityChallenge

  HTTP Method: POST

• ▼ ▲ firebaseappcheck.projects.apps.exchangePlayIntegrityToken

  Description: Validates an [integrity verdict response token from Play Integrity](https://developer.android.com/google/play/integrity/verdict#decrypt-verify). If valid, returns an AppCheckToken.

  Scopes:

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

  HTTP Method: POST

  Flat Path: v1beta/projects/{projectsId}/apps/{appsId}:exchangePlayIntegrityToken

  Path: v1beta/{+app}:exchangePlayIntegrityToken

  Parameters:

  app

  Required: Yes

  Type: string

  Description: Required. The relative resource name of the Android 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: ^projects/[^/]+/apps/[^/]+$

  Parameter Order: app

• ▼ ▲ firebaseappcheck.projects.apps.playIntegrityConfig.get

  Parameters:

  name

  Description: Required. The relative resource name of the PlayIntegrityConfig, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```

  Location: path

  Required: Yes

  Pattern: ^projects/[^/]+/apps/[^/]+/playIntegrityConfig$

  Type: string

  Parameter Order: name

  Description: Gets the PlayIntegrityConfig for the specified app.

  Scopes:

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

  Path: v1beta/{+name}

  Flat Path: v1beta/projects/{projectsId}/apps/{appsId}/playIntegrityConfig

  HTTP Method: GET

• ▼ ▲ firebaseappcheck.projects.apps.playIntegrityConfig.patch

  Description: Updates the PlayIntegrityConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange Play Integrity tokens for App Check tokens.

  HTTP Method: PATCH

  Scopes:

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

  Flat Path: v1beta/projects/{projectsId}/apps/{appsId}/playIntegrityConfig

  Parameter Order: name

  Path: v1beta/{+name}

  Parameters:

  name

  Description: Required. The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```

  Pattern: ^projects/[^/]+/apps/[^/]+/playIntegrityConfig$

  Required: Yes

  Type: string

  Location: path

  updateMask

  Type: string

  Description: Required. A comma-separated list of names of fields in the PlayIntegrityConfig Gets to update. Example: `token_ttl`.

  Location: query

  Format: google-fieldmask

• ▼ ▲ firebaseappcheck.projects.apps.playIntegrityConfig.batchGet

  HTTP Method: GET

  Scopes:

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

  Flat Path: v1beta/projects/{projectsId}/apps/-/playIntegrityConfig:batchGet

  Path: v1beta/{+parent}/apps/-/playIntegrityConfig:batchGet

  Parameter Order: parent

  Description: Atomically gets the PlayIntegrityConfigs for the specified list of apps.

  Parameters:

  parent

  Required: Yes

  Type: string

  Location: path

  Pattern: ^projects/[^/]+$

  Description: Required. The parent project name shared by all PlayIntegrityConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

  names

  Location: query

  Type: string

  Repeated: Yes

  Description: Required. The relative resource names of the PlayIntegrityConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` A maximum of 100 objects can be retrieved in a batch.