Namespace Google.Apis.Firebaseappcheck.v1beta

Classes

FirebaseappcheckBaseServiceRequest<TResponse>

A base abstract class for Firebaseappcheck requests.

FirebaseappcheckService.Scope

Available OAuth 2.0 scopes for use with the Firebase App Check API.

FirebaseappcheckService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Firebase App Check API.

Returns a public JWK set as specified by RFC 7517 that can be used to verify App Check tokens. Exactly one of the public keys in the returned set will successfully validate any App Check token that is currently valid.

OauthClientsResource

The "oauthClients" collection of methods.

OauthClientsResource.ExchangeAppAttestAssertionRequest

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

OauthClientsResource.ExchangeAppAttestAttestationRequest

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).

OauthClientsResource.ExchangeDebugTokenRequest

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.

OauthClientsResource.GenerateAppAttestChallengeRequest

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.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.AppsResource

The "apps" collection of methods.

ProjectsResource.AppsResource.AppAttestConfigResource

The "appAttestConfig" collection of methods.

ProjectsResource.AppsResource.AppAttestConfigResource.BatchGetRequest

Atomically gets the AppAttestConfigs for the specified list of apps.

ProjectsResource.AppsResource.AppAttestConfigResource.GetRequest

Gets the AppAttestConfig for the specified app.

ProjectsResource.AppsResource.AppAttestConfigResource.PatchRequest

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.

ProjectsResource.AppsResource.DebugTokensResource

The "debugTokens" collection of methods.

ProjectsResource.AppsResource.DebugTokensResource.CreateRequest

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.

ProjectsResource.AppsResource.DebugTokensResource.DeleteRequest

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.

ProjectsResource.AppsResource.DebugTokensResource.GetRequest

Gets the specified DebugToken. For security reasons, the token field is never populated in the response.

ProjectsResource.AppsResource.DebugTokensResource.ListRequest

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

ProjectsResource.AppsResource.DebugTokensResource.PatchRequest

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.

ProjectsResource.AppsResource.DeviceCheckConfigResource

The "deviceCheckConfig" collection of methods.

ProjectsResource.AppsResource.DeviceCheckConfigResource.BatchGetRequest

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

ProjectsResource.AppsResource.DeviceCheckConfigResource.GetRequest

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

ProjectsResource.AppsResource.DeviceCheckConfigResource.PatchRequest

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.

ProjectsResource.AppsResource.ExchangeAppAttestAssertionRequest

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

ProjectsResource.AppsResource.ExchangeAppAttestAttestationRequest

ProjectsResource.AppsResource.ExchangeCustomTokenRequest

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

ProjectsResource.AppsResource.ExchangeDebugTokenRequest

ProjectsResource.AppsResource.ExchangeDeviceCheckTokenRequest

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

ProjectsResource.AppsResource.ExchangePlayIntegrityTokenRequest

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

ProjectsResource.AppsResource.ExchangeRecaptchaEnterpriseTokenRequest

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

ProjectsResource.AppsResource.ExchangeRecaptchaTokenRequest

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

ProjectsResource.AppsResource.ExchangeRecaptchaV3TokenRequest

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

ProjectsResource.AppsResource.ExchangeSafetyNetTokenRequest

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

ProjectsResource.AppsResource.GenerateAppAttestChallengeRequest

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.

ProjectsResource.AppsResource.GeneratePlayIntegrityChallengeRequest

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.

ProjectsResource.AppsResource.PlayIntegrityConfigResource

The "playIntegrityConfig" collection of methods.

ProjectsResource.AppsResource.PlayIntegrityConfigResource.BatchGetRequest

Atomically gets the PlayIntegrityConfigs for the specified list of apps.

ProjectsResource.AppsResource.PlayIntegrityConfigResource.GetRequest

Gets the PlayIntegrityConfig for the specified app.

ProjectsResource.AppsResource.PlayIntegrityConfigResource.PatchRequest

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.

ProjectsResource.AppsResource.RecaptchaConfigResource

The "recaptchaConfig" collection of methods.

ProjectsResource.AppsResource.RecaptchaConfigResource.BatchGetRequest

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

ProjectsResource.AppsResource.RecaptchaConfigResource.GetRequest

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

ProjectsResource.AppsResource.RecaptchaConfigResource.PatchRequest

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.

ProjectsResource.AppsResource.RecaptchaEnterpriseConfigResource

The "recaptchaEnterpriseConfig" collection of methods.

ProjectsResource.AppsResource.RecaptchaEnterpriseConfigResource.BatchGetRequest

Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

ProjectsResource.AppsResource.RecaptchaEnterpriseConfigResource.GetRequest

Gets the RecaptchaEnterpriseConfig for the specified app.

ProjectsResource.AppsResource.RecaptchaEnterpriseConfigResource.PatchRequest

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.

ProjectsResource.AppsResource.RecaptchaV3ConfigResource

The "recaptchaV3Config" collection of methods.

ProjectsResource.AppsResource.RecaptchaV3ConfigResource.BatchGetRequest

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

ProjectsResource.AppsResource.RecaptchaV3ConfigResource.GetRequest

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

ProjectsResource.AppsResource.RecaptchaV3ConfigResource.PatchRequest

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response.

ProjectsResource.AppsResource.SafetyNetConfigResource

The "safetyNetConfig" collection of methods.

ProjectsResource.AppsResource.SafetyNetConfigResource.BatchGetRequest

Atomically gets the SafetyNetConfigs for the specified list of apps.

ProjectsResource.AppsResource.SafetyNetConfigResource.GetRequest

Gets the SafetyNetConfig for the specified app.

ProjectsResource.AppsResource.SafetyNetConfigResource.PatchRequest

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.

ProjectsResource.ServicesResource

The "services" collection of methods.

ProjectsResource.ServicesResource.BatchUpdateRequest

Atomically updates the specified Service configurations.

ProjectsResource.ServicesResource.GetRequest

Gets the Service configuration for the specified service name.

ProjectsResource.ServicesResource.ListRequest

Lists all Service configurations for the specified project. Only Services which were explicitly configured using UpdateService or BatchUpdateServices will be returned.

ProjectsResource.ServicesResource.PatchRequest

Updates the specified Service configuration.

ProjectsResource.ServicesResource.ResourcePoliciesResource

The "resourcePolicies" collection of methods.

ProjectsResource.ServicesResource.ResourcePoliciesResource.BatchUpdateRequest

Atomically updates the specified ResourcePolicy configurations.

ProjectsResource.ServicesResource.ResourcePoliciesResource.CreateRequest

Creates the specified ResourcePolicy configuration.

ProjectsResource.ServicesResource.ResourcePoliciesResource.DeleteRequest

Deletes the specified ResourcePolicy configuration.

ProjectsResource.ServicesResource.ResourcePoliciesResource.GetRequest

Gets the requested ResourcePolicy configuration.

ProjectsResource.ServicesResource.ResourcePoliciesResource.ListRequest

Lists all ResourcePolicy configurations for the specified project and service.

ProjectsResource.ServicesResource.ResourcePoliciesResource.PatchRequest

Updates the specified ResourcePolicy configuration.

ProjectsResource.VerifyAppCheckTokenRequest

Verifies the given App Check token and returns token usage signals that callers may act upon. This method currently only supports App Check tokens exchanged from the following attestation providers: * Play Integrity API * App Attest * DeviceCheck (DCDevice tokens) * reCAPTCHA Enterprise * reCAPTCHA v3 * Custom providers App Check tokens exchanged from debug secrets are also supported. Calling this method on an otherwise valid App Check token with an unsupported provider will cause an HTTP 400 error to be returned. Returns whether this token was already consumed before this call. If this is the first time this method has seen the given App Check token, the field already_consumed in the response will be absent. The given token will then be marked as already_consumed (set to true) for all future invocations of this method for that token. Note that if the given App Check token is invalid, an HTTP 403 error is returned instead of a response object, regardless whether the token was already consumed. Currently, when evaluating whether an App Check token was already consumed, only calls to this exact method are counted. Use of the App Check token elsewhere will not mark the token as being already consumed. The caller must have the firebaseappcheck.appCheckTokens.verify permission to call this method. This permission is part of the Firebase App Check Token Verifier role.

Namespace Google.Apis.Firebaseappcheck.v1beta

Classes

Enums