Firebase App Check API

Sprawdzanie aplikacji Firebase współpracuje z innymi usługami Firebase, aby chronić zasoby backendu przed nadużyciami, takimi jak oszustwa związane z płatnościami czy phishing.

Usługa: firebaseappcheck.googleapis.com

W celu wywołania tej usługi zalecamy użycie dostarczonych przez Google bibliotek klienta. Jeśli do wywołania tej usługi aplikacja musi używać własnych bibliotek, podczas tworzenia żądań do interfejsu API używaj podanych niżej informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i korzystanie z nich. Służy do tworzenia bibliotek klienta, wtyczek IDE i innych narzędzi, które współdziałają z interfejsami API Google. Jedna usługa może udostępniać wiele dokumentów opisujących. Ta usługa udostępnia następujące dokumenty wykrywania:

Punkt końcowy usługi

Punkt końcowy usługi to podstawowy adres URL, który określa adres sieciowy usługi interfejsu API. Jedna usługa może mieć wiele punktów końcowych. Ta usługa ma następujący punkt końcowy, a wszystkie poniższe identyfikatory URI odnoszą się do niego:

  • https://firebaseappcheck.googleapis.com

Zasób REST: v1beta.jwks

Metody
get GET /v1beta/{name}
Zwraca publiczny zestaw JWK określony zgodnie z RFC 7517, który może być używany do weryfikowania tokenów sprawdzania aplikacji.

Zasób REST: v1beta.oauthClients

Metody
exchangeAppAttestAssertion POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAssertion
Akceptuje potwierdzenie App Attest oraz artefakt uzyskany wcześniej od ExchangeAppAttestAttestation oraz weryfikuje je u Apple.
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
Akceptuje atest CBOR w usłudze App Attest i weryfikuje je w Apple przy użyciu wstępnie skonfigurowanych identyfikatorów zespołów i pakietów.
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
Weryfikuje obiekt tajny tokena debugowania utworzony wcześniej za pomocą metody CreateDebugToken.
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
Generuje wyzwanie, które zabezpiecza integralność wywołania funkcji ExchangeAppAttestAttestation lub ExchangeAppAttestAssertion tuż po niej.

Zasób REST: v1beta.projects

Metody
verifyAppCheckToken POST /v1beta/{project=projects/*}:verifyAppCheckToken
Weryfikuje podany token Sprawdzania aplikacji i zwraca sygnały o wykorzystaniu tokena, na których mogą działać elementy wywołujące.

Zasób REST: v1beta.projects.apps

Metody
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Akceptuje potwierdzenie App Attest oraz artefakt uzyskany wcześniej od ExchangeAppAttestAttestation oraz weryfikuje je u Apple.
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Akceptuje atest CBOR w usłudze App Attest i weryfikuje je w Apple przy użyciu wstępnie skonfigurowanych identyfikatorów zespołów i pakietów.
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
Weryfikuje token niestandardowy podpisany przy użyciu danych logowania do konta usługi pakietu Admin SDK w Twoim projekcie.
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
Weryfikuje obiekt tajny tokena debugowania utworzony wcześniej za pomocą metody CreateDebugToken.
exchangeDeviceCheckToken POST /v1beta/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Akceptuje metodę device_token wydaną przez DeviceCheck i próbuje zweryfikować ją przez Apple.
exchangePlayIntegrityToken POST /v1beta/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Weryfikuje token odpowiedzi oceny integralności z Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Weryfikuje token odpowiedzi reCAPTCHA Enterprise.
exchangeRecaptchaToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken
Weryfikuje token odpowiedzi reCAPTCHA v3.
exchangeRecaptchaV3Token POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Weryfikuje token odpowiedzi reCAPTCHA v3.
exchangeSafetyNetToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeSafetyNetToken
Weryfikuj token SafetyNet.
generateAppAttestChallenge POST /v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge
Generuje wyzwanie, które zabezpiecza integralność wywołania funkcji ExchangeAppAttestAttestation lub ExchangeAppAttestAssertion tuż po niej.
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Generuje wyzwanie, które chroni integralność wysyłanego bezpośrednio do interfejsu Play Integrity API żądania oceny integralności.

Zasób REST: v1beta.projects.apps.appAttestConfig

Metody
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Atomically pobiera wartości AppAttestConfig dla określonej listy aplikacji.
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
Pobiera AppAttestConfig dla określonej aplikacji.
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Aktualizuje AppAttestConfig w określonej aplikacji.

Zasób REST: v1beta.projects.apps.debugTokens

Metody
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
Tworzy nowy element DebugToken dla określonej aplikacji.
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
Usuwa określone właściwości DebugToken.
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
Pobiera określony DebugToken.
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
Wyświetla listę wszystkich elementów DebugToken dla określonej aplikacji.
patch PATCH /v1beta/{debugToken.name=projects/*/apps/*/debugTokens/*}
Aktualizuje określone DebugToken.

Zasób REST: v1beta.projects.apps.deviceCheckConfig

Metody
batchGet GET /v1beta/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Atomically pobiera wartości DeviceCheckConfig dla określonej listy aplikacji.
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
Pobiera DeviceCheckConfig dla określonej aplikacji.
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Aktualizuje DeviceCheckConfig w określonej aplikacji.

Zasób REST: v1beta.projects.apps.playIntegrityConfig

Metody
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Atomically pobiera wartości PlayIntegrityConfig dla określonej listy aplikacji.
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
Pobiera PlayIntegrityConfig dla określonej aplikacji.
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Aktualizuje PlayIntegrityConfig w określonej aplikacji.

Zasób REST: v1beta.projects.apps.recaptchaConfig

Metody
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
Atomically pobiera wartości RecaptchaConfig dla określonej listy aplikacji.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
Pobiera RecaptchaConfig dla określonej aplikacji.
patch
(deprecated)		 PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
Aktualizuje RecaptchaConfig w określonej aplikacji.

Zasób REST: v1beta.projects.apps.recaptchaEnterpriseConfig

Metody
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Atomically pobiera wartości RecaptchaEnterpriseConfig dla określonej listy aplikacji.
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Pobiera RecaptchaEnterpriseConfig dla określonej aplikacji.
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Aktualizuje RecaptchaEnterpriseConfig w określonej aplikacji.

Zasób REST: v1beta.projects.apps.recaptchaV3Config

Metody
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Atomically pobiera wartości RecaptchaV3Config dla określonej listy aplikacji.
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
Pobiera RecaptchaV3Config dla określonej aplikacji.
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Aktualizuje RecaptchaV3Config w określonej aplikacji.

Zasób REST: v1beta.projects.apps.safetyNetConfig

Metody
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Atomically pobiera wartości SafetyNetConfig dla określonej listy aplikacji.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
Pobiera SafetyNetConfig dla określonej aplikacji.
patch
(deprecated)		 PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Aktualizuje SafetyNetConfig w określonej aplikacji.

Zasób REST: v1beta.projects.services

Metody
batchUpdate POST /v1beta/{parent=projects/*}/services:batchUpdate
Atomowo aktualizuje określone konfiguracje Service.
get GET /v1beta/{name=projects/*/services/*}
Pobiera konfigurację Service dla określonej nazwy usługi.
list GET /v1beta/{parent=projects/*}/services
Wyświetla wszystkie konfiguracje Service w wybranym projekcie.
patch PATCH /v1beta/{service.name=projects/*/services/*}
Aktualizuje podaną konfigurację Service.

Zasób REST: v1.jwks

Metody
get GET /v1/{name}
Zwraca publiczny zestaw JWK określony zgodnie z RFC 7517, który może być używany do weryfikowania tokenów sprawdzania aplikacji.

Zasób REST: v1.projects.apps

Metody
exchangeAppAttestAssertion POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Akceptuje potwierdzenie App Attest oraz artefakt uzyskany wcześniej od ExchangeAppAttestAttestation oraz weryfikuje je u Apple.
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Akceptuje atest CBOR w usłudze App Attest i weryfikuje je w Apple przy użyciu wstępnie skonfigurowanych identyfikatorów zespołów i pakietów.
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
Weryfikuje token niestandardowy podpisany przy użyciu danych logowania do konta usługi pakietu Admin SDK w Twoim projekcie.
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
Weryfikuje obiekt tajny tokena debugowania utworzony wcześniej za pomocą metody CreateDebugToken.
exchangeDeviceCheckToken POST /v1/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Akceptuje metodę device_token wydaną przez DeviceCheck i próbuje zweryfikować ją przez Apple.
exchangePlayIntegrityToken POST /v1/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Weryfikuje token odpowiedzi oceny integralności z Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Weryfikuje token odpowiedzi reCAPTCHA Enterprise.
exchangeRecaptchaV3Token POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Weryfikuje token odpowiedzi reCAPTCHA v3.
exchangeSafetyNetToken
(deprecated)		 POST /v1/{app=projects/*/apps/*}:exchangeSafetyNetToken
Weryfikuj token SafetyNet.
generateAppAttestChallenge POST /v1/{app=projects/*/apps/*}:generateAppAttestChallenge
Generuje wyzwanie, które zabezpiecza integralność wywołania funkcji ExchangeAppAttestAttestation lub ExchangeAppAttestAssertion tuż po niej.
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Generuje wyzwanie, które chroni integralność wysyłanego bezpośrednio do interfejsu Play Integrity API żądania oceny integralności.

Zasób REST: v1.projects.apps.appAttestConfig

Metody
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Atomically pobiera wartości AppAttestConfig dla określonej listy aplikacji.
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
Pobiera AppAttestConfig dla określonej aplikacji.
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Aktualizuje AppAttestConfig w określonej aplikacji.

Zasób REST: v1.projects.apps.debugTokens

Metody
create POST /v1/{parent=projects/*/apps/*}/debugTokens
Tworzy nowy element DebugToken dla określonej aplikacji.
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
Usuwa określone właściwości DebugToken.
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
Pobiera określony DebugToken.
list GET /v1/{parent=projects/*/apps/*}/debugTokens
Wyświetla listę wszystkich elementów DebugToken dla określonej aplikacji.
patch PATCH /v1/{debugToken.name=projects/*/apps/*/debugTokens/*}
Aktualizuje określone DebugToken.

Zasób REST: v1.projects.apps.deviceCheckConfig

Metody
batchGet GET /v1/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Atomically pobiera wartości DeviceCheckConfig dla określonej listy aplikacji.
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
Pobiera DeviceCheckConfig dla określonej aplikacji.
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Aktualizuje DeviceCheckConfig w określonej aplikacji.

Zasób REST: v1.projects.apps.playIntegrityConfig

Metody
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Atomically pobiera wartości PlayIntegrityConfig dla określonej listy aplikacji.
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
Pobiera PlayIntegrityConfig dla określonej aplikacji.
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Aktualizuje PlayIntegrityConfig w określonej aplikacji.

Zasób REST: v1.projects.apps.recaptchaEnterpriseConfig

Metody
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Atomically pobiera wartości RecaptchaEnterpriseConfig dla określonej listy aplikacji.
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Pobiera RecaptchaEnterpriseConfig dla określonej aplikacji.
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Aktualizuje RecaptchaEnterpriseConfig w określonej aplikacji.

Zasób REST: v1.projects.apps.recaptchaV3Config

Metody
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Atomically pobiera wartości RecaptchaV3Config dla określonej listy aplikacji.
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
Pobiera RecaptchaV3Config dla określonej aplikacji.
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Aktualizuje RecaptchaV3Config w określonej aplikacji.

Zasób REST: v1.projects.apps.safetyNetConfig

Metody
batchGet
(deprecated)		 GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Atomically pobiera wartości SafetyNetConfig dla określonej listy aplikacji.
get
(deprecated)		 GET /v1/{name=projects/*/apps/*/safetyNetConfig}
Pobiera SafetyNetConfig dla określonej aplikacji.
patch
(deprecated)		 PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Aktualizuje SafetyNetConfig w określonej aplikacji.

Zasób REST: v1.projects.services

Metody
batchUpdate POST /v1/{parent=projects/*}/services:batchUpdate
Atomowo aktualizuje określone konfiguracje Service.
get GET /v1/{name=projects/*/services/*}
Pobiera konfigurację Service dla określonej nazwy usługi.
list GET /v1/{parent=projects/*}/services
Wyświetla wszystkie konfiguracje Service w wybranym projekcie.
patch PATCH /v1/{service.name=projects/*/services/*}
Aktualizuje podaną konfigurację Service.