- apps-appAttestConfig-batchGet$
- apps-appAttestConfig-get$
- apps-appAttestConfig-patch$
- apps-debugTokens-create$
- apps-debugTokens-delete$
- apps-debugTokens-get$
- apps-debugTokens-list$
- apps-debugTokens-patch$
- apps-deviceCheckConfig-batchGet$
- apps-deviceCheckConfig-get$
- apps-deviceCheckConfig-patch$
- apps-exchangeAppAttestAssertion$
- apps-exchangeAppAttestAttestation$
- apps-exchangeCustomToken$
- apps-exchangeDebugToken$
- apps-exchangeDeviceCheckToken$
- apps-exchangeRecaptchaToken$
- apps-exchangeSafetyNetToken$
- apps-generateAppAttestChallenge$
- apps-recaptchaConfig-batchGet$
- apps-recaptchaConfig-get$
- apps-recaptchaConfig-patch$
- apps-safetyNetConfig-batchGet$
- apps-safetyNetConfig-get$
- apps-safetyNetConfig-patch$
- services-batchUpdate$
- services-get$
- services-list$
- services-patch$
happygapi.firebaseappcheck.projects
Firebase App Check API: projects. App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing. With App Check, devices running your app will use an app or device attestation provider that attests to one or both of the following: * Requests originate from your authentic app * Requests originate from an authentic, untampered device This attestation is attached to every request your app makes to your Firebase backend resources. The Firebase App Check REST API allows you to manage your App Check configurations programmatically. It also allows you to exchange attestation material for App Check tokens directly without using a Firebase SDK. Finally, it allows you to obtain the public key set necessary to validate an App Check token yourself. Learn more about App Check. See: https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects
Firebase App Check API: projects. App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing. With App Check, devices running your app will use an app or device attestation provider that attests to one or both of the following: * Requests originate from your authentic app * Requests originate from an authentic, untampered device This attestation is attached to every request your app makes to your Firebase backend resources. The Firebase App Check REST API allows you to manage your App Check configurations programmatically. It also allows you to exchange attestation material for App Check tokens directly without using a Firebase SDK. Finally, it allows you to obtain the public key set necessary to validate an App Check token yourself. [Learn more about App Check](https://firebase.google.com/docs/app-check). See: https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects
apps-appAttestConfig-batchGet$clj
(apps-appAttestConfig-batchGet$ auth parameters)Required parameters: parent
Optional parameters: names
Gets the AppAttestConfigs for the specified list of apps atomically.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/appAttestConfig/batchGet Required parameters: parent Optional parameters: names Gets the AppAttestConfigs for the specified list of apps atomically.
apps-appAttestConfig-get$clj
(apps-appAttestConfig-get$ auth parameters)Required parameters: name
Optional parameters: none
Gets the AppAttestConfig for the specified app.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/appAttestConfig/get Required parameters: name Optional parameters: none Gets the AppAttestConfig for the specified app.
apps-appAttestConfig-patch$clj
(apps-appAttestConfig-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :tokenTtl string}
Updates the AppAttestConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange AppAttest tokens for App Check tokens.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/appAttestConfig/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :tokenTtl string}
Updates the AppAttestConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange AppAttest tokens for App Check tokens.apps-debugTokens-create$clj
(apps-debugTokens-create$ auth parameters body)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/create
Required parameters: parent
Optional parameters: none
Body:
{:displayName string, :token string, :name string}
Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the token field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/create
Required parameters: parent
Optional parameters: none
Body:
{:displayName string, :token string, :name string}
Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the `token` field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.apps-debugTokens-delete$clj
(apps-debugTokens-delete$ auth parameters)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/delete
Required parameters: name
Optional parameters: none
Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret token has been compromised or when you no longer need the debug token.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/delete Required parameters: name Optional parameters: none Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.
apps-debugTokens-get$clj
(apps-debugTokens-get$ auth parameters)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/get
Required parameters: name
Optional parameters: none
Gets the specified DebugToken. For security reasons, the token field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/get Required parameters: name Optional parameters: none Gets the specified DebugToken. For security reasons, the `token` field is never populated in the response.
apps-debugTokens-list$clj
(apps-debugTokens-list$ auth parameters)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/list
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists all DebugTokens for the specified app. For security reasons, the token field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/list Required parameters: parent Optional parameters: pageSize, pageToken Lists all DebugTokens for the specified app. For security reasons, the `token` field is never populated in the response.
apps-debugTokens-patch$clj
(apps-debugTokens-patch$ auth parameters body)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:displayName string, :token string, :name string}
Updates the specified DebugToken. For security reasons, the token field cannot be updated, nor will it be populated in the response, but you can revoke the debug token using DeleteDebugToken.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/debugTokens/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:displayName string, :token string, :name string}
Updates the specified DebugToken. For security reasons, the `token` field cannot be updated, nor will it be populated in the response, but you can revoke the debug token using DeleteDebugToken.apps-deviceCheckConfig-batchGet$clj
(apps-deviceCheckConfig-batchGet$ auth parameters)Required parameters: parent
Optional parameters: names
Gets the DeviceCheckConfigs for the specified list of apps atomically. For security reasons, the private_key field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/deviceCheckConfig/batchGet Required parameters: parent Optional parameters: names Gets the DeviceCheckConfigs for the specified list of apps atomically. For security reasons, the `private_key` field is never populated in the response.
apps-deviceCheckConfig-get$clj
(apps-deviceCheckConfig-get$ auth parameters)Required parameters: name
Optional parameters: none
Gets the DeviceCheckConfig for the specified app. For security reasons, the private_key field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/deviceCheckConfig/get Required parameters: name Optional parameters: none Gets the DeviceCheckConfig for the specified app. For security reasons, the `private_key` field is never populated in the response.
apps-deviceCheckConfig-patch$clj
(apps-deviceCheckConfig-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:privateKey string, :privateKeySet boolean, :name string, :tokenTtl string, :keyId string}
Updates the DeviceCheckConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange DeviceCheck tokens for App Check tokens. For security reasons, the private_key field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/deviceCheckConfig/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:privateKey string,
:privateKeySet boolean,
:name string,
:tokenTtl string,
:keyId string}
Updates the DeviceCheckConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange DeviceCheck tokens for App Check tokens. For security reasons, the `private_key` field is never populated in the response.apps-exchangeAppAttestAssertion$clj
(apps-exchangeAppAttestAssertion$ auth parameters body)Required parameters: app
Optional parameters: none
Body:
{:assertion string, :artifact string, :challenge string}
Accepts a AppAttest Artifact and Assertion, and uses the developer's preconfigured auth token to verify the token with Apple. Returns an AttestationToken with the App ID as specified by the app field included as attested claims.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeAppAttestAssertion
Required parameters: app
Optional parameters: none
Body:
{:assertion string, :artifact string, :challenge string}
Accepts a AppAttest Artifact and Assertion, and uses the developer's preconfigured auth token to verify the token with Apple. Returns an AttestationToken with the App ID as specified by the `app` field included as attested claims.apps-exchangeAppAttestAttestation$clj
(apps-exchangeAppAttestAttestation$ auth parameters body)Required parameters: app
Optional parameters: none
Body:
{:challenge string, :keyId string, :attestationStatement string}
Accepts a AppAttest CBOR Attestation, and uses the developer's preconfigured team and bundle IDs to verify the token with Apple. Returns an Attestation Artifact that can later be exchanged for an AttestationToken in ExchangeAppAttestAssertion.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeAppAttestAttestation
Required parameters: app
Optional parameters: none
Body:
{:challenge string, :keyId string, :attestationStatement string}
Accepts a AppAttest CBOR Attestation, and uses the developer's preconfigured team and bundle IDs to verify the token with Apple. Returns an Attestation Artifact that can later be exchanged for an AttestationToken in ExchangeAppAttestAssertion.apps-exchangeCustomToken$clj
(apps-exchangeCustomToken$ auth parameters body)Required parameters: app
Optional parameters: none
Body:
{:customToken string}
Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeCustomToken
Required parameters: app
Optional parameters: none
Body:
{:customToken string}
Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.apps-exchangeDebugToken$clj
(apps-exchangeDebugToken$ auth parameters body)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeDebugToken
Required parameters: app
Optional parameters: none
Body:
{:debugToken string}
Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an App Check token encapsulated in an AttestationTokenResponse. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeDebugToken
Required parameters: app
Optional parameters: none
Body:
{:debugToken string}
Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an App Check token encapsulated in an AttestationTokenResponse. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.apps-exchangeDeviceCheckToken$clj
(apps-exchangeDeviceCheckToken$ auth parameters body)Required parameters: app
Optional parameters: none
Body:
{:deviceToken string}
Accepts a device_token issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeDeviceCheckToken
Required parameters: app
Optional parameters: none
Body:
{:deviceToken string}
Accepts a [`device_token`](https://developer.apple.com/documentation/devicecheck/dcdevice) issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.apps-exchangeRecaptchaToken$clj
(apps-exchangeRecaptchaToken$ auth parameters body)Required parameters: app
Optional parameters: none
Body:
{:recaptchaToken string}
Validates a reCAPTCHA v3 response token. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeRecaptchaToken
Required parameters: app
Optional parameters: none
Body:
{:recaptchaToken string}
Validates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.apps-exchangeSafetyNetToken$clj
(apps-exchangeSafetyNetToken$ auth parameters body)Required parameters: app
Optional parameters: none
Body:
{:safetyNetToken string}
Validates a SafetyNet token. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/exchangeSafetyNetToken
Required parameters: app
Optional parameters: none
Body:
{:safetyNetToken string}
Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.apps-generateAppAttestChallenge$clj
(apps-generateAppAttestChallenge$ auth parameters body)Required parameters: app
Optional parameters: none
Body:
{}
Initiates the App Attest flow by generating a challenge which will be used as a type of nonce for this attestation.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/generateAppAttestChallenge
Required parameters: app
Optional parameters: none
Body:
{}
Initiates the App Attest flow by generating a challenge which will be used as a type of nonce for this attestation.apps-recaptchaConfig-batchGet$clj
(apps-recaptchaConfig-batchGet$ auth parameters)Required parameters: parent
Optional parameters: names
Gets the RecaptchaConfigs for the specified list of apps atomically. For security reasons, the site_secret field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/recaptchaConfig/batchGet Required parameters: parent Optional parameters: names Gets the RecaptchaConfigs for the specified list of apps atomically. For security reasons, the `site_secret` field is never populated in the response.
apps-recaptchaConfig-get$clj
(apps-recaptchaConfig-get$ auth parameters)Required parameters: name
Optional parameters: none
Gets the RecaptchaConfig for the specified app. For security reasons, the site_secret field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/recaptchaConfig/get Required parameters: name Optional parameters: none Gets the RecaptchaConfig for the specified app. For security reasons, the `site_secret` field is never populated in the response.
apps-recaptchaConfig-patch$clj
(apps-recaptchaConfig-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :tokenTtl string, :siteSecretSet boolean, :siteSecret string}
Updates the RecaptchaConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/recaptchaConfig/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:tokenTtl string,
:siteSecretSet boolean,
:siteSecret string}
Updates the RecaptchaConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.apps-safetyNetConfig-batchGet$clj
(apps-safetyNetConfig-batchGet$ auth parameters)Required parameters: parent
Optional parameters: names
Gets the SafetyNetConfigs for the specified list of apps atomically.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/safetyNetConfig/batchGet Required parameters: parent Optional parameters: names Gets the SafetyNetConfigs for the specified list of apps atomically.
apps-safetyNetConfig-get$clj
(apps-safetyNetConfig-get$ auth parameters)Required parameters: name
Optional parameters: none
Gets the SafetyNetConfig for the specified app.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/safetyNetConfig/get Required parameters: name Optional parameters: none Gets the SafetyNetConfig for the specified app.
apps-safetyNetConfig-patch$clj
(apps-safetyNetConfig-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :tokenTtl string}
Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/apps/safetyNetConfig/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :tokenTtl string}
Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.services-batchUpdate$clj
(services-batchUpdate$ auth parameters body)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/batchUpdate
Required parameters: parent
Optional parameters: none
Body:
{:requests [{:updateMask string, :service GoogleFirebaseAppcheckV1betaService}], :updateMask string}
Updates the specified Service configurations atomically.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/batchUpdate
Required parameters: parent
Optional parameters: none
Body:
{:requests [{:updateMask string,
:service GoogleFirebaseAppcheckV1betaService}],
:updateMask string}
Updates the specified Service configurations atomically.services-get$clj
(services-get$ auth parameters)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/get
Required parameters: name
Optional parameters: none
Gets the Service configuration for the specified service name.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/get Required parameters: name Optional parameters: none Gets the Service configuration for the specified service name.
services-list$clj
(services-list$ auth parameters)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/list
Required parameters: parent
Optional parameters: pageToken, pageSize
Lists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be returned.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/list Required parameters: parent Optional parameters: pageToken, pageSize Lists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be returned.
services-patch$clj
(services-patch$ auth parameters body)https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :enforcementMode string}
Updates the specified Service configuration.
https://firebase.google.com/docs/app-checkapi/reference/rest/v1beta/projects/services/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :enforcementMode string}
Updates the specified Service configuration.cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close