Firebase App Check API (firebaseappcheck:v1beta)

2022-05-03

5 new methods

Additions

    Methods
  • firebaseappcheck.projects.apps.exchangePlayIntegrityToken

      Parameters :

        app

          Type : string

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

          Location : path

          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.

          Required : Yes

      HTTP Method : POST

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

      Path : v1beta/{+app}: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
    • Parameter Order : app

  • firebaseappcheck.projects.apps.generatePlayIntegrityChallenge

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • 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.

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

      Path : v1beta/{+app}:generatePlayIntegrityChallenge

      Parameter Order : app

      Parameters :

        app

          Type : string

          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.

          Required : Yes

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

      HTTP Method : POST

  • firebaseappcheck.projects.apps.playIntegrityConfig.get

      Scopes :

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

      Parameters :

        name

          Type : string

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

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

          Location : path

          Required : Yes

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

      Description : Gets the PlayIntegrityConfig for the specified app.

      Parameter Order : name

      Path : v1beta/{+name}

  • firebaseappcheck.projects.apps.playIntegrityConfig.batchGet

      Parameters :

        parent

          Type : string

          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.

          Required : Yes

          Pattern : ^projects/[^/]+$

        names

          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.

          Location : query

          Type : string

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

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

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

      Scopes :

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

      Parameter Order : parent

  • 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.

      Path : v1beta/{+name}

      Parameters :

        name

          Type : string

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

          Location : path

          Required : Yes

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

        updateMask

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

          Location : query

          Type : string

          Format : google-fieldmask

      HTTP Method : PATCH

      Parameter Order : name

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

      Scopes :

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