2022-04-05
▼ ▲ firebaseappcheck.projects.apps.exchangePlayIntegrityToken
Parameter Order : app
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
Scopes :
Path : v1beta/{+app}:exchangePlayIntegrityToken
Flat Path : v1beta/projects/{projectsId}/apps/{appsId}:exchangePlayIntegrityToken
Parameters :
app
Pattern : ^projects/[^/]+/apps/[^/]+$
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.
Location : path
Type : string
▼ ▲ firebaseappcheck.projects.apps.generatePlayIntegrityChallenge
Flat Path : v1beta/projects/{projectsId}/apps/{appsId}:generatePlayIntegrityChallenge
Scopes :
Parameter Order : app
Parameters :
app
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/apps/[^/]+$
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.
HTTP Method : POST
Path : v1beta/{+app}: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.
▼ ▲ 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.
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/apps/[^/]+/playIntegrityConfig$
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
Format : google-fieldmask
Type : string
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/apps/{appsId}/playIntegrityConfig
HTTP Method : PATCH
Scopes :
▼ ▲ firebaseappcheck.projects.apps.playIntegrityConfig.get
Scopes :
Description : Gets the PlayIntegrityConfig for the specified app.
Parameters :
name
Description : Required. The relative resource name of the PlayIntegrityConfig, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/apps/[^/]+/playIntegrityConfig$
Flat Path : v1beta/projects/{projectsId}/apps/{appsId}/playIntegrityConfig
HTTP Method : GET
Path : v1beta/{+name}
Parameter Order : name
▼ ▲ firebaseappcheck.projects.apps.playIntegrityConfig.batchGet
Flat Path : v1beta/projects/{projectsId}/apps/-/playIntegrityConfig:batchGet
Parameter Order : parent
HTTP Method : GET
Description : Atomically gets the PlayIntegrityConfigs for the specified list of apps.
Path : v1beta/{+parent}/apps/-/playIntegrityConfig:batchGet
Scopes :
Parameters :
names
Type : string
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.
Repeated : Yes
Location : query
parent
Location : path
Required : Yes
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
Pattern : ^projects/[^/]+$