Liking cljdoc? Tell your friends :D

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
raw docstring

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.
raw docstring

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.
raw docstring

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.
raw docstring

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: pageToken, pageSize

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: pageToken, pageSize

Lists all DebugTokens for the specified app. For security reasons, the `token` field is never populated in the response.
raw docstring

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.
raw docstring

apps-deviceCheckConfig-batchGet$clj

(apps-deviceCheckConfig-batchGet$ auth parameters)

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.

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.
raw docstring

apps-deviceCheckConfig-get$clj

(apps-deviceCheckConfig-get$ auth parameters)

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.

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.
raw docstring

apps-deviceCheckConfig-patch$clj

(apps-deviceCheckConfig-patch$ auth parameters body)

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

Required parameters: name

Optional parameters: updateMask

Body:

{:keyId string, :name string, :privateKey string, :privateKeySet boolean}

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: 

{:keyId string,
 :name string,
 :privateKey string,
 :privateKeySet boolean}

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.
raw docstring

apps-exchangeCustomToken$clj

(apps-exchangeCustomToken$ auth parameters body)

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.

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.
raw docstring

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.
raw docstring

apps-exchangeDeviceCheckToken$clj

(apps-exchangeDeviceCheckToken$ auth parameters body)

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 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.
raw docstring

apps-exchangeRecaptchaToken$clj

(apps-exchangeRecaptchaToken$ auth parameters body)

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. 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.
raw docstring

apps-exchangeSafetyNetToken$clj

(apps-exchangeSafetyNetToken$ auth parameters body)

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. 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.
raw docstring

apps-recaptchaConfig-batchGet$clj

(apps-recaptchaConfig-batchGet$ auth parameters)

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.

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.
raw docstring

apps-recaptchaConfig-get$clj

(apps-recaptchaConfig-get$ auth parameters)

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.

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.
raw docstring

apps-recaptchaConfig-patch$clj

(apps-recaptchaConfig-patch$ auth parameters body)

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

Required parameters: name

Optional parameters: updateMask

Body:

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

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, :siteSecret string, :siteSecretSet boolean}

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.
raw docstring

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:

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

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: 

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

Updates the specified Service configurations atomically.
raw docstring

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.
raw docstring

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.
raw docstring

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.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close