Firebase App Check API

Проверка приложений Firebase работает вместе с другими службами Firebase, помогая защитить ваши серверные ресурсы от злоупотреблений, таких как мошенничество с выставлением счетов или фишинг.

Сервис: firebaseappcheck.googleapis.com.

Для вызова этой службы мы рекомендуем использовать клиентские библиотеки Google. Если вашему приложению необходимо использовать собственные библиотеки для вызова этой службы, используйте следующую информацию при отправке запросов API.

Документ открытия

Документ обнаружения — это машиночитаемая спецификация для описания и использования REST API. Он используется для создания клиентских библиотек, плагинов IDE и других инструментов, взаимодействующих с API Google. Одна служба может предоставлять несколько документов обнаружения. Эта служба предоставляет следующие документы обнаружения:

Конечная точка службы

Конечная точка службы — это базовый URL-адрес, указывающий сетевой адрес службы API. Одна служба может иметь несколько конечных точек службы. Эта служба имеет следующую конечную точку службы, и все приведенные ниже URI относятся к этой конечной точке службы:

  • https://firebaseappcheck.googleapis.com

Ресурс REST: v1beta.jwks

Методы
get GET /v1beta/{name}
Возвращает общедоступный набор JWK, указанный в RFC 7517 , который можно использовать для проверки токенов проверки приложений.

Ресурс REST: v1beta.oauthClients

Методы
exchangeAppAttestAssertion POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAssertion
Принимает утверждение App Attest и артефакт, ранее полученный от ExchangeAppAttestAttestation , и проверяет их в Apple.
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
Принимает аттестацию App Attest CBOR и проверяет ее в Apple, используя предварительно настроенную команду и идентификаторы пакета.
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
Проверяет секрет токена отладки, который вы ранее создали с помощью CreateDebugToken .
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
Создает вызов, который защищает целостность следующего вызова ExchangeAppAttestAttestation или ExchangeAppAttestAssertion .

Ресурс REST: v1beta.projects

Методы
verifyAppCheckToken POST /v1beta/{project=projects/*}:verifyAppCheckToken
Проверяет данный токен проверки приложений и возвращает сигналы использования токена, на которые могут действовать вызывающие абоненты.

Ресурс REST: v1beta.projects.apps

Методы
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Принимает утверждение App Attest и артефакт, ранее полученный от ExchangeAppAttestAttestation , и проверяет их в Apple.
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Принимает аттестацию App Attest CBOR и проверяет ее в Apple, используя предварительно настроенную команду и идентификаторы пакета.
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
Проверяет пользовательский токен, подписанный с использованием учетных данных сервисной учетной записи Admin SDK вашего проекта.
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
Проверяет секрет токена отладки, который вы ранее создали с помощью CreateDebugToken .
exchangeDeviceCheckToken POST /v1beta/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Принимает device_token выданный DeviceCheck, и пытается проверить его в Apple.
exchangePlayIntegrityToken POST /v1beta/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Проверяет токен ответа на вердикт целостности от Play Integrity .
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Проверяет токен ответа reCAPTCHA Enterprise .
exchangeRecaptchaToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken
Проверяет токен ответа reCAPTCHA v3 .
exchangeRecaptchaV3Token POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Проверяет токен ответа reCAPTCHA v3 .
exchangeSafetyNetToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeSafetyNetToken
Проверяет токен SafetyNet .
generateAppAttestChallenge POST /v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge
Создает вызов, который защищает целостность следующего вызова ExchangeAppAttestAttestation или ExchangeAppAttestAssertion .
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Создает запрос, который защищает целостность следующего запроса вердикта целостности к Play Integrity API.

Ресурс REST: v1beta.projects.apps.appAttestConfig .

Методы
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Атомарно получает AppAttestConfig для указанного списка приложений.
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
Получает AppAttestConfig для указанного приложения.
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Обновляет AppAttestConfig для указанного приложения.

Ресурс REST: v1beta.projects.apps.debugTokens .

Методы
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
Создает новый DebugToken для указанного приложения.
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
Удаляет указанный DebugToken .
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
Получает указанный DebugToken .
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
Перечисляет все DebugToken для указанного приложения.
patch PATCH /v1beta/{debugToken.name=projects/*/apps/*/debugTokens/*}
Обновляет указанный DebugToken .

Ресурс REST: v1beta.projects.apps.deviceCheckConfig .

Методы
batchGet GET /v1beta/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Атомарно получает DeviceCheckConfig для указанного списка приложений.
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
Получает DeviceCheckConfig для указанного приложения.
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Обновляет DeviceCheckConfig для указанного приложения.

Ресурс REST: v1beta.projects.apps.playIntegrityConfig .

Методы
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Атомарно получает PlayIntegrityConfig для указанного списка приложений.
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
Получает PlayIntegrityConfig для указанного приложения.
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Обновляет PlayIntegrityConfig для указанного приложения.

Ресурс REST: v1beta.projects.apps.recaptchaConfig .

Методы
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
Атомически получает RecaptchaConfig для указанного списка приложений.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
Получает RecaptchaConfig для указанного приложения.
patch
(deprecated)		 PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
Обновляет RecaptchaConfig для указанного приложения.

Ресурс REST: v1beta.projects.apps.recaptchaEnterpriseConfig .

Методы
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Атомически получает RecaptchaEnterpriseConfig для указанного списка приложений.
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Получает RecaptchaEnterpriseConfig для указанного приложения.
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Обновляет RecaptchaEnterpriseConfig для указанного приложения.

Ресурс REST: v1beta.projects.apps.recaptchaV3Config .

Методы
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Атомически получает RecaptchaV3Config для указанного списка приложений.
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
Получает RecaptchaV3Config для указанного приложения.
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Обновляет RecaptchaV3Config для указанного приложения.

Ресурс REST: v1beta.projects.apps.safetyNetConfig .

Методы
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Атомарно получает SafetyNetConfig для указанного списка приложений.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
Получает SafetyNetConfig для указанного приложения.
patch
(deprecated)		 PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Обновляет SafetyNetConfig для указанного приложения.

Ресурс REST: v1beta.projects.services

Методы
batchUpdate POST /v1beta/{parent=projects/*}/services:batchUpdate
Атомически обновляет указанные конфигурации Service .
get GET /v1beta/{name=projects/*/services/*}
Получает конфигурацию Service для указанного имени службы.
list GET /v1beta/{parent=projects/*}/services
Перечисляет все конфигурации Service для указанного проекта.
patch PATCH /v1beta/{service.name=projects/*/services/*}
Обновляет указанную конфигурацию Service .

Ресурс REST: v1.jwks

Методы
get GET /v1/{name}
Возвращает общедоступный набор JWK, указанный в RFC 7517 , который можно использовать для проверки токенов проверки приложений.

Ресурс REST: v1.projects.apps

Методы
exchangeAppAttestAssertion POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Принимает утверждение App Attest и артефакт, ранее полученный от ExchangeAppAttestAttestation , и проверяет их в Apple.
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Принимает аттестацию App Attest CBOR и проверяет ее в Apple, используя предварительно настроенную команду и идентификаторы пакета.
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
Проверяет пользовательский токен, подписанный с использованием учетных данных сервисной учетной записи Admin SDK вашего проекта.
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
Проверяет секрет токена отладки, который вы ранее создали с помощью CreateDebugToken .
exchangeDeviceCheckToken POST /v1/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Принимает device_token выданный DeviceCheck, и пытается проверить его в Apple.
exchangePlayIntegrityToken POST /v1/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Проверяет токен ответа на вердикт целостности от Play Integrity .
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Проверяет токен ответа reCAPTCHA Enterprise .
exchangeRecaptchaV3Token POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Проверяет токен ответа reCAPTCHA v3 .
exchangeSafetyNetToken
(deprecated)		 POST /v1/{app=projects/*/apps/*}:exchangeSafetyNetToken
Проверяет токен SafetyNet .
generateAppAttestChallenge POST /v1/{app=projects/*/apps/*}:generateAppAttestChallenge
Создает вызов, который защищает целостность следующего вызова ExchangeAppAttestAttestation или ExchangeAppAttestAssertion .
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Создает запрос, который защищает целостность следующего запроса вердикта целостности к Play Integrity API.

Ресурс REST: v1.projects.apps.appAttestConfig .

Методы
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Атомарно получает AppAttestConfig для указанного списка приложений.
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
Получает AppAttestConfig для указанного приложения.
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Обновляет AppAttestConfig для указанного приложения.

Ресурс REST: v1.projects.apps.debugTokens .

Методы
create POST /v1/{parent=projects/*/apps/*}/debugTokens
Создает новый DebugToken для указанного приложения.
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
Удаляет указанный DebugToken .
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
Получает указанный DebugToken .
list GET /v1/{parent=projects/*/apps/*}/debugTokens
Перечисляет все DebugToken для указанного приложения.
patch PATCH /v1/{debugToken.name=projects/*/apps/*/debugTokens/*}
Обновляет указанный DebugToken .

Ресурс REST: v1.projects.apps.deviceCheckConfig .

Методы
batchGet GET /v1/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Атомарно получает DeviceCheckConfig для указанного списка приложений.
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
Получает DeviceCheckConfig для указанного приложения.
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Обновляет DeviceCheckConfig для указанного приложения.

Ресурс REST: v1.projects.apps.playIntegrityConfig .

Методы
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Атомарно получает PlayIntegrityConfig для указанного списка приложений.
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
Получает PlayIntegrityConfig для указанного приложения.
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Обновляет PlayIntegrityConfig для указанного приложения.

Ресурс REST: v1.projects.apps.recaptchaEnterpriseConfig .

Методы
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Атомически получает RecaptchaEnterpriseConfig для указанного списка приложений.
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Получает RecaptchaEnterpriseConfig для указанного приложения.
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Обновляет RecaptchaEnterpriseConfig для указанного приложения.

Ресурс REST: v1.projects.apps.recaptchaV3Config .

Методы
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Атомически получает RecaptchaV3Config для указанного списка приложений.
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
Получает RecaptchaV3Config для указанного приложения.
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Обновляет RecaptchaV3Config для указанного приложения.

Ресурс REST: v1.projects.apps.safetyNetConfig .

Методы
batchGet
(deprecated)		 GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Атомарно получает SafetyNetConfig для указанного списка приложений.
get
(deprecated)		 GET /v1/{name=projects/*/apps/*/safetyNetConfig}
Получает SafetyNetConfig для указанного приложения.
patch
(deprecated)		 PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Обновляет SafetyNetConfig для указанного приложения.

Ресурс REST: v1.projects.services

Методы
batchUpdate POST /v1/{parent=projects/*}/services:batchUpdate
Атомически обновляет указанные конфигурации Service .
get GET /v1/{name=projects/*/services/*}
Получает конфигурацию Service для указанного имени службы.
list GET /v1/{parent=projects/*}/services
Перечисляет все конфигурации Service для указанного проекта.
patch PATCH /v1/{service.name=projects/*/services/*}
Обновляет указанную конфигурацию Service .