REST Resource: projects.services

Resource: Service

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

JSON representation 
{
  "name": string,
  "enforcementMode": enum (EnforcementMode)
}
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:

  • firebasestorage.googleapis.com (Cloud Storage for Firebase)
  • firebasedatabase.googleapis.com (Firebase Realtime Database)
  • firestore.googleapis.com (Cloud Firestore)
enforcementMode

enum (EnforcementMode)

Required. The App Check enforcement mode for this service.

EnforcementMode

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

Enums
OFF

Firebase App Check is not enforced for the service, nor are App Check metrics collected.

Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced.

An unconfigured service is in this mode by default.
UNENFORCED

Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service.

Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced.
ENFORCED

Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers.

While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time.

Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services.

If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use.

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.