REST Resource: projects.apps.deviceCheckConfig

Resource: DeviceCheckConfig

An app's DeviceCheck configuration object. This configuration is used by ExchangeDeviceCheckToken to validate device tokens issued to apps by DeviceCheck. It also controls certain properties of the returned AppCheckToken, such as its ttl.

Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the Firebase Management Service.

JSON representation 
{
  "name": string,
  "tokenTtl": string,
  "keyId": string,
  "privateKey": string,
  "privateKeySet": boolean
}
Fields
name

string

Required. The relative resource name of the DeviceCheck configuration object, in the format:

projects/{project_number}/apps/{app_id}/deviceCheckConfig
tokenTtl

string (Duration format)

Specifies the duration for which App Check tokens exchanged from DeviceCheck tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
keyId

string

Required. The key identifier of a private key enabled with DeviceCheck, created in your Apple Developer account.
privateKey

string

Required. Input only. The contents of the private key (.p8) file associated with the key specified by keyId.

For security reasons, this field will never be populated in any response.
privateKeySet

boolean

Output only. Whether the privateKey field was previously set. Since we will never return the privateKey field, this field is the only way to find out whether it was previously set.

Methods

batchGet

 Atomically gets the DeviceCheckConfigs for the specified list of apps.

get

 Gets the DeviceCheckConfig for the specified app.

patch

 Updates the DeviceCheckConfig for the specified app.