Google

Firebase App Check API

Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing.

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing.

Endpoints 26

projects.services.resourcePolicies

  • GETGets the requested ResourcePolicy configuration./v1/:nameGets the requested ResourcePolicy configuration.
  • DELETEDeletes the specified ResourcePolicy configuration./v1/:name?etag=stringDeletes the specified ResourcePolicy configuration.
  • PATCHUpdates the specified ResourcePolicy configuration./v1/:name?updateMask=stringUpdates the specified ResourcePolicy configuration.
  • POSTAtomically updates the specified ResourcePolicy configurations./v1/:parent/resourcePolicies:batchUpdateAtomically updates the specified ResourcePolicy configurations.
  • GETLists all ResourcePolicy configurations for the specified project and service./v1/:parent/resourcePolicies?filter=string&pageSize=0&pageToken=stringLists all ResourcePolicy configurations for the specified project and service.
  • POSTCreates the specified ResourcePolicy configuration./v1/:parent/resourcePoliciesCreates the specified ResourcePolicy configuration.

projects.apps

  • POSTAccepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies…/v1/:app:exchangeAppAttestAssertionAccepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an…
  • POSTAccepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs/v1/:app:exchangeAppAttestAttestationAccepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that…
  • POSTValidates a debug token secret that you have previously created using CreateDebugToken/v1/:app:exchangeDebugTokenValidates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive quota is…
  • POSTGenerates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or…/v1/:app:generateAppAttestChallengeGenerates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge…
  • POSTValidates a custom token signed using your project's Admin SDK service account credentials/v1/:app:exchangeCustomTokenValidates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an AppCheckToken.
  • POSTAccepts a [`device_token`](https://developer.apple.com/documentation/devicecheck/dcdevice) issued by DeviceCheck, and…/v1/:app:exchangeDeviceCheckTokenAccepts a device_token issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an AppCheckToken.
  • POSTValidates an [integrity verdict response token from Play…/v1/:app:exchangePlayIntegrityTokenValidates an integrity verdict response token from Play Integrity. If valid, returns an AppCheckToken.
  • POSTValidates a [reCAPTCHA Enterprise response…/v1/:app:exchangeRecaptchaEnterpriseTokenValidates a reCAPTCHA Enterprise response token. If valid, returns an AppCheckToken.
  • POSTValidates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3)/v1/:app:exchangeRecaptchaV3TokenValidates a reCAPTCHA v3 response token. If valid, returns an AppCheckToken.
  • POSTGenerates a challenge that protects the integrity of an immediately following integrity verdict request to the Play…/v1/:app:generatePlayIntegrityChallengeGenerates a challenge that protects the integrity of an immediately following integrity verdict request to the Play Integrity API. The next call to…
  • POSTMints a new App Check token for the specified Firebase App/v1/:app:mintAppCheckTokenMints a new App Check token for the specified Firebase App. This method is intended to be called from a privileged environment where the caller can be…

projects.apps.appAttestConfig

  • GETAtomically gets the AppAttestConfigs for the specified list of apps./v1/:parent/apps/-/appAttestConfig:batchGet?names=stringAtomically gets the AppAttestConfigs for the specified list of apps.

projects.apps.debugTokens

  • GETLists all DebugTokens for the specified app/v1/:parent/debugTokens?pageSize=0&pageToken=stringLists all DebugTokens for the specified app. For security reasons, the token field is never populated in the response.
  • POSTCreates a new DebugToken for the specified app/v1/:parent/debugTokensCreates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the token field cannot be updated or retrieved,…

projects.apps.deviceCheckConfig

  • GETAtomically gets the DeviceCheckConfigs for the specified list of apps/v1/:parent/apps/-/deviceCheckConfig:batchGet?names=stringAtomically gets the DeviceCheckConfigs for the specified list of apps. For security reasons, the private_key field is never populated in the response.

projects.apps.playIntegrityConfig

  • GETAtomically gets the PlayIntegrityConfigs for the specified list of apps./v1/:parent/apps/-/playIntegrityConfig:batchGet?names=stringAtomically gets the PlayIntegrityConfigs for the specified list of apps.

projects.apps.recaptchaEnterpriseConfig

  • GETAtomically gets the RecaptchaEnterpriseConfigs for the specified list of apps./v1/:parent/apps/-/recaptchaEnterpriseConfig:batchGet?names=stringAtomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

projects.apps.recaptchaV3Config

  • GETAtomically gets the RecaptchaV3Configs for the specified list of apps/v1/:parent/apps/-/recaptchaV3Config:batchGet?names=stringAtomically gets the RecaptchaV3Configs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.

projects.services

  • POSTAtomically updates the specified Service configurations./v1/:parent/services:batchUpdateAtomically updates the specified Service configurations.
  • GETLists all Service configurations for the specified project/v1/:parent/services?pageSize=0&pageToken=stringLists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be…

API details

Base URL
https://firebaseappcheck.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
26 operations on 22 pathsPOST 15GET 9PATCH 1DELETE 1
Main resources
projects.apps 11projects.services.resourcePolicies 6projects.apps.debugTokens 2projects.services 2projects.apps.appAttestConfig 1projects.apps.deviceCheckConfig 1projects.apps.playIntegrityConfig 1projects.apps.recaptchaEnterpriseConfig 1projects.apps.recaptchaV3Config 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Firebase App Check API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Firebase App Check API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets the requested ResourcePolicy configuration.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Firebase App Check API?

Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing. It is listed under Developer tools and has 26 endpoints.

Who publishes the Firebase App Check API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Firebase App Check API?

Requests go to https://firebaseappcheck.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Firebase App Check API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the Firebase App Check API have?

26 operations on 22 paths (15 POST, 9 GET, 1 PATCH, 1 DELETE). The largest groups are projects.apps, projects.services.resourcePolicies, projects.apps.debugTokens, projects.services.

Is forking the Firebase App Check API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.