Firebase App Check API (firebaseappcheck:v1beta)

Additions

Methods


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

  Parameters :

  name

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

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

  Location : path

  Type : string

  Required : Yes

  updateMask

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

  Location : query

  Type : string

  Format : google-fieldmask

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

  Scopes :

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

  HTTP Method : PATCH

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

  Deprecated : Yes

  Path : v1beta/{+name}

  Parameter Order : name

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

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

  Scopes :

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

  Parameters :

  name

  Required : Yes

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

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

  Location : path

  Type : string

  Path : v1beta/{+name}

  Parameter Order : name

  HTTP Method : GET

  Deprecated : Yes

  Description : Gets the SafetyNetConfig for the specified app.

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

  Parameters :

  parent

  Required : Yes

  Pattern : ^projects/[^/]+$

  Description : Required. The parent project name shared by all SafetyNetConfigs 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.

  Location : path

  Type : string

  names

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

  Location : query

  Repeated : Yes

  Type : string

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

  Scopes :

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

  HTTP Method : GET

  Deprecated : Yes

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

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

  Parameter Order : parent

• ▼ ▲ firebaseappcheck.projects.apps.exchangeSafetyNetToken

  Deprecated : Yes

  Description : Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.

  HTTP Method : POST

  Parameter Order : app

  Path : v1beta/{+app}:exchangeSafetyNetToken

  Parameters :

  app

  Required : Yes

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

  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

  Type : string

  Scopes :

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

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