happygapi.firebaseappcheck.projects — happygapi 0.4.9

Firebase App Check API: projects. Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing. See: https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects

apps-appAttestConfig-batchGet$ clj

(apps-appAttestConfig-batchGet$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/appAttestConfig/batchGet

Required parameters: parent

Optional parameters: names

Atomically gets the AppAttestConfigs for the specified list of apps.

apps-appAttestConfig-get$ clj

(apps-appAttestConfig-get$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/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)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/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/v1/projects/apps/debugTokens/create

Required parameters: parent

Optional parameters: none

Body:

{:name string, :token string, :displayName 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/v1/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/v1/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/v1/projects/apps/debugTokens/list

Required parameters: parent

Optional parameters: pageToken, pageSize

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/v1/projects/apps/debugTokens/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :token string, :displayName 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)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/deviceCheckConfig/batchGet

Required parameters: parent

Optional parameters: names

Atomically gets the DeviceCheckConfigs for the specified list of apps. For security reasons, the private_key field is never populated in the response.

apps-deviceCheckConfig-get$ clj

(apps-deviceCheckConfig-get$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/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)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/deviceCheckConfig/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:privateKey string, :tokenTtl string, :name string, :privateKeySet boolean, :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)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeAppAttestAssertion

Required parameters: app

Optional parameters: none

Body:

{:artifact string, :challenge string, :limitedUse boolean, :assertion string}

Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.

apps-exchangeAppAttestAttestation$ clj

(apps-exchangeAppAttestAttestation$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeAppAttestAttestation

Required parameters: app

Optional parameters: none

Body:

{:limitedUse boolean, :challenge string, :keyId string, :attestationStatement string}

Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful).

apps-exchangeCustomToken$ clj

(apps-exchangeCustomToken$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeCustomToken

Required parameters: app

Optional parameters: none

Body:

{:limitedUse boolean, :customToken string}

Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an AppCheckToken.

apps-exchangeDebugToken$ clj

(apps-exchangeDebugToken$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeDebugToken

Required parameters: app

Optional parameters: none

Body:

{:debugToken string, :limitedUse boolean}

Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. 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)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeDeviceCheckToken

Required parameters: app

Optional parameters: none

Body:

{:limitedUse boolean, :deviceToken string}

Accepts a device_token issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an AppCheckToken.

apps-exchangePlayIntegrityToken$ clj

(apps-exchangePlayIntegrityToken$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangePlayIntegrityToken

Required parameters: app

Optional parameters: none

Body:

{:limitedUse boolean, :playIntegrityToken string}

Validates an integrity verdict response token from Play Integrity. If valid, returns an AppCheckToken.

apps-exchangeRecaptchaEnterpriseToken$ clj

(apps-exchangeRecaptchaEnterpriseToken$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeRecaptchaEnterpriseToken

Required parameters: app

Optional parameters: none

Body:

{:limitedUse boolean, :recaptchaEnterpriseToken string}

Validates a reCAPTCHA Enterprise response token. If valid, returns an AppCheckToken.

apps-exchangeRecaptchaV3Token$ clj

(apps-exchangeRecaptchaV3Token$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeRecaptchaV3Token

Required parameters: app

Optional parameters: none

Body:

{:recaptchaV3Token string, :limitedUse boolean}

Validates a reCAPTCHA v3 response token. If valid, returns an AppCheckToken.

apps-exchangeSafetyNetToken$ clj

(apps-exchangeSafetyNetToken$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/exchangeSafetyNetToken

Required parameters: app

Optional parameters: none

Body:

{:safetyNetToken string}

Validates a SafetyNet token. If valid, returns an AppCheckToken.

apps-generateAppAttestChallenge$ clj

(apps-generateAppAttestChallenge$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/generateAppAttestChallenge

Required parameters: app

Optional parameters: none

Body:

{}

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

apps-generatePlayIntegrityChallenge$ clj

(apps-generatePlayIntegrityChallenge$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/generatePlayIntegrityChallenge

Required parameters: app

Optional parameters: none

Body:

{}

Generates a challenge that protects the integrity of an immediately following integrity verdict request to the Play Integrity API. The next call to ExchangePlayIntegrityToken using the resulting integrity token will verify the presence and validity of the challenge. A challenge should not be reused for multiple calls.

apps-playIntegrityConfig-batchGet$ clj

(apps-playIntegrityConfig-batchGet$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/playIntegrityConfig/batchGet

Required parameters: parent

Optional parameters: names

Atomically gets the PlayIntegrityConfigs for the specified list of apps.

apps-playIntegrityConfig-get$ clj

(apps-playIntegrityConfig-get$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/playIntegrityConfig/get

Required parameters: name

Optional parameters: none

Gets the PlayIntegrityConfig for the specified app.

apps-playIntegrityConfig-patch$ clj

(apps-playIntegrityConfig-patch$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/playIntegrityConfig/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :tokenTtl string}

Updates the PlayIntegrityConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange Play Integrity tokens for App Check tokens.

apps-recaptchaEnterpriseConfig-batchGet$ clj

(apps-recaptchaEnterpriseConfig-batchGet$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/recaptchaEnterpriseConfig/batchGet

Required parameters: parent

Optional parameters: names

Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

apps-recaptchaEnterpriseConfig-get$ clj

(apps-recaptchaEnterpriseConfig-get$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/recaptchaEnterpriseConfig/get

Required parameters: name

Optional parameters: none

Gets the RecaptchaEnterpriseConfig for the specified app.

apps-recaptchaEnterpriseConfig-patch$ clj

(apps-recaptchaEnterpriseConfig-patch$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/recaptchaEnterpriseConfig/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :tokenTtl string, :siteKey string}

Updates the RecaptchaEnterpriseConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA Enterprise tokens for App Check tokens.

apps-recaptchaV3Config-batchGet$ clj

(apps-recaptchaV3Config-batchGet$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/recaptchaV3Config/batchGet

Required parameters: parent

Optional parameters: names

Atomically gets the RecaptchaV3Configs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.

apps-recaptchaV3Config-get$ clj

(apps-recaptchaV3Config-get$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/recaptchaV3Config/get

Required parameters: name

Optional parameters: none

Gets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response.

apps-recaptchaV3Config-patch$ clj

(apps-recaptchaV3Config-patch$ auth parameters body)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/recaptchaV3Config/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:siteSecret string, :tokenTtl string, :siteSecretSet boolean, :name string}

Updates the RecaptchaV3Config 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)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/projects/apps/safetyNetConfig/batchGet

Required parameters: parent

Optional parameters: names

Atomically gets the SafetyNetConfigs for the specified list of apps.

apps-safetyNetConfig-get$ clj

(apps-safetyNetConfig-get$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/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)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/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/v1/projects/services/batchUpdate

Required parameters: parent

Optional parameters: none

Body:

{:requests [{:updateMask string, :service GoogleFirebaseAppcheckV1Service}], :updateMask string}

Atomically updates the specified Service configurations.

services-get$ clj

(services-get$ auth parameters)

https://firebase.google.com/docs/app-checkapi/reference/rest/v1/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/v1/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/v1/projects/services/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :enforcementMode string}

Updates the specified Service configuration.