REST Resource: projects.services

Resource: Service

The enforcement configuration for a Firebase service supported by App Check.

JSON representation
{
  "name": string,
  "enforcementMode": enum (EnforcementMode),
  "replayProtection": enum (EnforcementMode),
  "updateTime": string,
  "etag": string
}
Fields
name

string

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

projects/{project_number}/services/{service_id}

Note that the service_id element must be a supported service ID. Currently, the following service IDs are supported.

Firebase and Google Cloud services:

  • identitytoolkit.googleapis.com (Firebase Authentication)
  • firebasedataconnect.googleapis.com (Firebase SQL Connect)
  • firestore.googleapis.com (Cloud Firestore)
  • firebasedatabase.googleapis.com (Firebase Realtime Database)
  • firebasestorage.googleapis.com (Cloud Storage for Firebase)
  • firebaseml.googleapis.com (Firebase AI Logic)

Google Maps Platform services:

  • maps-backend.googleapis.com (Maps JavaScript API)
  • places.googleapis.com (Places API (New))

Other supported Google services:

  • oauth2.googleapis.com (Google Identity for iOS)

Note: While all the supported service_ids may appear to be subdomains of googleapis.com, the service_id has no semantic meaning beyond identifying the service to App Check. It is not intended to represent the actual domain to which your apps send traffic, nor is it necessarily the API that should be enabled to use the service. For information on using these Google services, consult their documentation.

enforcementMode

enum (EnforcementMode)

Required. The baseline protection EnforcementMode for this service.

replayProtection

enum (EnforcementMode)

Optional. The replay protection EnforcementMode for this service.

Note that this field cannot be set to a level higher than that of baseline protection. For example, if the enforcement mode for baseline protection is set to UNENFORCED, this field cannot be set to ENFORCED. In order to enforce replay protection, you must first enforce App Check's baseline protection. An HTTP 400 error will be returned in this case.

By default, this field is set to OFF. Setting this field to UNENFORCED or ENFORCED is considered opting into replay protection. Opting in can impact your requests by adding some latency and sometimes cost (depending on your attestation provider). To opt out of replay protection after opting in, set this field to OFF.

updateTime

string (Timestamp format)

Output only. Timestamp when this service configuration object was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

etag

string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

This etag is strongly validated as defined by RFC 7232.

Methods

batchUpdate

Atomically updates the specified Service configurations.

get

Gets the Service configuration for the specified service name.

list

Lists all Service configurations for the specified project.

patch

Updates the specified Service configuration.