Show / Hide Table of Contents

Namespace Google.Apis.Firebaseappcheck.v1beta.Data

Classes

GoogleFirebaseAppcheckV1betaAppAttestConfig

An app's App Attest configuration object. This configuration controls certain properties of the AppCheckToken returned by ExchangeAppAttestAttestation and ExchangeAppAttestAssertion, such as its ttl. Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the Firebase Management Service.

GoogleFirebaseAppcheckV1betaAppCheckToken

Encapsulates an App Check token, which are used to access backend services protected by App Check.

GoogleFirebaseAppcheckV1betaAttestationTokenResponse

Encapsulates an App Check token, which are used to access Firebase services protected by App Check.

GoogleFirebaseAppcheckV1betaAutomation

An enforcement automation is useful for automatically enforcing a service or a resource policy within a service when a certain condition is met. For example, you may create an automation that automatically turns on enforcement for your Cloud Firestore service at a specified timestamp in the future. For your security, an automation object may be created by the system in order to protect sensitive services by default. These system-created automations can be opted out, if you so choose, by calling the SuspendAutomation method on them. Suspending a system-created automation is not recommended, but is supported for advanced use cases. The system will not execute nor modify any suspended automations. Also, system-created automations cannot be deleted, but can be freely modified, which is also not recommended, as the system may later overwrite your changes with its own default settings without notice (assuming it has not been suspended). An automation's condition is evaluated periodically; the frequency of this periodic evaluation depends on the exact condition. While the details are unspecified, evaluations will be conducted reasonably frequently so that a satisfied condition will be detected in a timely fashion. Once a condition has been detected to be satisfied, the enforcement action will be executed immediately. Currently, the only enforcement action supported is to enforce App Check protections on the associated parent service or parent resource policy. Once executed, the automation becomes immutable, and serves as a historical record of that execution. Its update_time field will be populated with the timestamp at which the execution occurred, and its state field will be set to SUCCEEDED. Successful automations not created by the system can still be deleted. If, during the evaluation or execution of an automation, App Check discovers that it is no longer possible for the service or resource to receive App Check protection, App Check may suspend your automation without warning. For example, if you have disabled a service, or have deleted all resources within a service, and that service does not support storing your App Check preferences while it is in such a state, then an automation created for this service may be suspended. Please ensure that the service or resource is correctly configured and operating normally throughout the lifetime of the automation to avoid suspension.

GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse

Response message for the BatchGetAppAttestConfigs method.

GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse

Response message for the BatchGetDeviceCheckConfigs method.

GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse

Response message for the BatchGetPlayIntegrityConfigs method.

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse

Response message for the BatchGetRecaptchaConfigs method.

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse

Response message for the BatchGetRecaptchaEnterpriseConfigs method.

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse

Response message for the BatchGetRecaptchaV3Configs method.

GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest

Request message for the BatchUpdateResourcePolicies method.

GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse

Response message for the BatchUpdateResourcePolicies method.

GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest

Request message for the BatchUpdateServices method.

GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse

Response message for the BatchUpdateServices method.

GoogleFirebaseAppcheckV1betaDebugToken

A debug token is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.

GoogleFirebaseAppcheckV1betaDeviceCheckConfig

An app's DeviceCheck configuration object. This configuration is used by ExchangeDeviceCheckToken to validate device tokens issued to apps by DeviceCheck. It also controls certain properties of the returned AppCheckToken, such as its ttl. Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the Firebase Management Service.

GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest

Request message for the ExchangeAppAttestAssertion method.

GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest

Request message for the ExchangeAppAttestAttestation method.

GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse

Response message for the ExchangeAppAttestAttestation method.

GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest

Request message for the ExchangeCustomToken method.

GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest

Request message for the ExchangeDebugToken method.

GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest

Request message for the ExchangeDeviceCheckToken method.

GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest

Request message for the ExchangePlayIntegrityToken method.

GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest

Request message for the ExchangeRecaptchaEnterpriseToken method.

GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest

Request message for the ExchangeRecaptchaToken method.

GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest

Request message for the ExchangeRecaptchaV3Token method.

GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest

Request message for the GenerateAppAttestChallenge method.

GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse

Response message for the GenerateAppAttestChallenge method.

GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest

Request message for the GeneratePlayIntegrityChallenge method.

GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse

Response message for the GeneratePlayIntegrityChallenge method.

GoogleFirebaseAppcheckV1betaLimitedUseConfig

Configuration for a limited-use App Check token.

GoogleFirebaseAppcheckV1betaListAutomationsResponse

Response message for the ListAutomations method.

GoogleFirebaseAppcheckV1betaListDebugTokensResponse

Response message for the ListDebugTokens method.

GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse

Response message for the ListResourcePolicies method.

GoogleFirebaseAppcheckV1betaListServicesResponse

Response message for the ListServices method.

GoogleFirebaseAppcheckV1betaMintAppCheckTokenRequest

Request message for the MintAppCheckToken method.

GoogleFirebaseAppcheckV1betaMintAppCheckTokenResponse

Response message for the MintAppCheckToken method.

GoogleFirebaseAppcheckV1betaPlayIntegrityConfig

An app's Play Integrity configuration object. This configuration controls certain properties of the AppCheckToken returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the Firebase Management Service.

GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAccountDetails

A settings object specifying account requirements for Android devices running your app. These settings correspond to requirements on the account details field obtained from the Play Integrity API. See the default responses table for a quick summary. The default values for these settings work for most apps, and are recommended.

GoogleFirebaseAppcheckV1betaPlayIntegrityConfigAppIntegrity

A settings object specifying application integrity requirements for Android devices running your app. These settings correspond to requirements on the application integrity field obtained from the Play Integrity API. See the default responses table for a quick summary. The default values for these settings work for most apps, and are recommended.

GoogleFirebaseAppcheckV1betaPlayIntegrityConfigDeviceIntegrity

A settings object specifying device integrity requirements for Android devices running your app. These settings correspond to requirements on the device integrity field obtained from the Play Integrity API. See the default responses table for a quick summary. Warning: There are also conditional as well as optional responses that you can receive, but requires additional explicit opt-in from you. The App Check API is not responsible for any such opt-ins. The default values for these settings work for most apps, and are recommended.

GoogleFirebaseAppcheckV1betaPublicJwk

A JWK as specified by section 4 of RFC 7517 and section 6.3.1 of RFC 7518.

GoogleFirebaseAppcheckV1betaPublicJwkSet

The currently active set of public keys that can be used to verify App Check tokens. This object is a JWK set as specified by section 5 of RFC 7517. For security, the response must not be cached for longer than six hours.

GoogleFirebaseAppcheckV1betaRecaptchaConfig

An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned AppCheckToken, such as its ttl.

GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig

An app's reCAPTCHA Enterprise configuration object. This configuration is used by ExchangeRecaptchaEnterpriseToken to validate reCAPTCHA tokens issued to apps by reCAPTCHA Enterprise. It also controls certain properties of the returned AppCheckToken, such as its ttl.

GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfigRiskAnalysis

A settings object specifying risk tolerance and requirements for your application. These settings correspond to requirements on the riskAnalysis tuple in the assessment obtained from reCAPTCHA Enterprise. The default values for these settings work for most apps, and are recommended.

GoogleFirebaseAppcheckV1betaRecaptchaV3Config

An app's reCAPTCHA v3 configuration object. This configuration is used by ExchangeRecaptchaV3Token to validate reCAPTCHA tokens issued to apps by reCAPTCHA v3. It also controls certain properties of the returned AppCheckToken, such as its ttl.

GoogleFirebaseAppcheckV1betaResourcePolicy

App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.

GoogleFirebaseAppcheckV1betaService

The enforcement configuration for a Firebase service supported by App Check.

GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest

Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method.

GoogleFirebaseAppcheckV1betaUpdateServiceRequest

Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method.

GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenRequest

Request message for the VerifyAppCheckToken method.

GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenResponse

Response message for the VerifyAppCheckToken method.

GoogleProtobufEmpty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

In this article
Back to top Generated by DocFX