Firebase App Check API (firebaseappcheck:v1beta)

2022-04-29

5 new methods

Additions

    Methods
  • firebaseappcheck.projects.apps.generatePlayIntegrityChallenge

      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

      Parameter Order: app

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

      Parameters:

        app

          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.

          Required: Yes

          Location: path

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

          Type: string

      HTTP Method: POST

  • firebaseappcheck.projects.apps.exchangePlayIntegrityToken

      Scopes:

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

      Parameters:

        app

          Location: path

          Type: string

          Required: Yes

          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.

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

      Flat Path: v1beta/projects/{projectsId}/apps/{appsId}: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.

      HTTP Method: POST

      Path: v1beta/{+app}:exchangePlayIntegrityToken

  • firebaseappcheck.projects.apps.playIntegrityConfig.get

      Description: Gets the PlayIntegrityConfig for the specified app.

      HTTP Method: GET

      Parameters:

        name

          Type: string

          Required: Yes

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

          Location: path

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

      Parameter Order: name

      Path: v1beta/{+name}

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path: v1beta/projects/{projectsId}/apps/{appsId}/playIntegrityConfig

  • firebaseappcheck.projects.apps.playIntegrityConfig.patch

      Parameter Order: name

      Path: v1beta/{+name}

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

      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
    • Parameters:

        updateMask

          Location: query

          Type: string

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

          Format: google-fieldmask

        name

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

          Type: string

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

          Location: path

          Required: Yes

  • firebaseappcheck.projects.apps.playIntegrityConfig.batchGet

      Parameter Order: parent

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

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

      Parameters:

        parent

          Pattern: ^projects/[^/]+$

          Location: path

          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.

          Type: string

          Required: Yes

        names

          Location: query

          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.

          Type: string

          Repeated: Yes

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Path: v1beta/{+parent}/apps/-/playIntegrityConfig:batchGet