firebaseappcheck

package
v0.181.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package firebaseappcheck provides access to the Firebase App Check API.

For product documentation, see: https://firebase.google.com/docs/app-check

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/firebaseappcheck/v1beta"
...
ctx := context.Background()
firebaseappcheckService, err := firebaseappcheck.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

firebaseappcheckService, err := firebaseappcheck.NewService(ctx, option.WithScopes(firebaseappcheck.FirebaseScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

firebaseappcheckService, err := firebaseappcheck.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
firebaseappcheckService, err := firebaseappcheck.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View and administer all your Firebase data and settings
	FirebaseScope = "https://www.googleapis.com/auth/firebase"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleFirebaseAppcheckV1betaAppAttestConfig added in v0.51.0

type GoogleFirebaseAppcheckV1betaAppAttestConfig struct {
	// Name: Required. The relative resource name of the App Attest configuration
	// object, in the format: “`
	// projects/{project_number}/apps/{app_id}/appAttestConfig “`
	Name string `json:"name,omitempty"`
	// TokenTtl: Specifies the duration for which App Check tokens exchanged from
	// App Attest artifacts will be valid. If unset, a default value of 1 hour is
	// assumed. Must be between 30 minutes and 7 days, inclusive.
	TokenTtl string `json:"tokenTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps/patch).

func (*GoogleFirebaseAppcheckV1betaAppAttestConfig) MarshalJSON added in v0.51.0

type GoogleFirebaseAppcheckV1betaAppCheckToken added in v0.73.0

type GoogleFirebaseAppcheckV1betaAppCheckToken struct {
	// AttestationToken: An App Check token. App Check tokens are signed JWTs
	// (https://tools.ietf.org/html/rfc7519) containing claims that identify the
	// attested app and Firebase project. This token is used to access Firebase
	// services protected by App Check.
	AttestationToken string `json:"attestationToken,omitempty"`
	// Token: An App Check token. App Check tokens are signed JWTs
	// (https://tools.ietf.org/html/rfc7519) containing claims that identify the
	// attested app and Firebase project. This token is used to access Firebase
	// services protected by App Check.
	Token string `json:"token,omitempty"`
	// Ttl: The duration from the time this token is minted until its expiration.
	// This field is intended to ease client-side token management, since the
	// client may have clock skew, but is still able to accurately measure a
	// duration.
	Ttl string `json:"ttl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AttestationToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttestationToken") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleFirebaseAppcheckV1betaAppCheckToken) MarshalJSON added in v0.73.0

type GoogleFirebaseAppcheckV1betaAttestationTokenResponse

type GoogleFirebaseAppcheckV1betaAttestationTokenResponse struct {
	// AttestationToken: An App Check token. App Check tokens are signed JWTs
	// (https://tools.ietf.org/html/rfc7519) containing claims that identify the
	// attested app and Firebase project. This token is used to access Firebase
	// services protected by App Check.
	AttestationToken string `json:"attestationToken,omitempty"`
	// Ttl: The duration from the time this token is minted until its expiration.
	// This field is intended to ease client-side token management, since the
	// client may have clock skew, but is still able to accurately measure a
	// duration.
	Ttl string `json:"ttl,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttestationToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttestationToken") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleFirebaseAppcheckV1betaAttestationTokenResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse added in v0.51.0

type GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse struct {
	// Configs: AppAttestConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaAppAttestConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse: Response message for the BatchGetAppAttestConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse) MarshalJSON added in v0.51.0

type GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse

type GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse struct {
	// Configs: DeviceCheckConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaDeviceCheckConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse: Response message for the BatchGetDeviceCheckConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse added in v0.78.0

type GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse struct {
	// Configs: PlayIntegrityConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaPlayIntegrityConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse: Response message for the BatchGetPlayIntegrityConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse) MarshalJSON added in v0.78.0

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse struct {
	// Configs: RecaptchaConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaRecaptchaConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse: Response message for the BatchGetRecaptchaConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse added in v0.61.0

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse struct {
	// Configs: RecaptchaEnterpriseConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse: Response message for the BatchGetRecaptchaEnterpriseConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse) MarshalJSON added in v0.61.0

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse added in v0.74.0

type GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse struct {
	// Configs: RecaptchaV3Configs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaRecaptchaV3Config `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse: Response message for the BatchGetRecaptchaV3Configs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse) MarshalJSON added in v0.74.0

type GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse added in v0.51.0

type GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse struct {
	// Configs: SafetyNetConfigs retrieved.
	Configs []*GoogleFirebaseAppcheckV1betaSafetyNetConfig `json:"configs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Configs") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Configs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse: Response message for the BatchGetSafetyNetConfigs method.

func (*GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse) MarshalJSON added in v0.51.0

type GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest added in v0.154.0

type GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest struct {
	// Requests: Required. The request messages specifying the ResourcePolicy
	// objects to update. A maximum of 100 objects can be updated in a batch.
	Requests []*GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest `json:"requests,omitempty"`
	// UpdateMask: Optional. A comma-separated list of names of fields in the
	// ResourcePolicy objects to update. Example: `enforcement_mode`. If this field
	// is present, the `update_mask` field in the UpdateResourcePolicyRequest
	// messages must all match this field, or the entire batch fails and no updates
	// will be committed.
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Requests") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Requests") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest: Request message for the BatchUpdateResourcePolicies method.

func (*GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest) MarshalJSON added in v0.154.0

type GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse added in v0.154.0

type GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse struct {
	// ResourcePolicies: ResourcePolicy objects after the updates have been
	// applied.
	ResourcePolicies []*GoogleFirebaseAppcheckV1betaResourcePolicy `json:"resourcePolicies,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ResourcePolicies") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ResourcePolicies") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse: Response message for the BatchUpdateResourcePolicies method.

func (*GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse) MarshalJSON added in v0.154.0

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest struct {
	// Requests: Required. The request messages specifying the Services to update.
	// A maximum of 100 objects can be updated in a batch.
	Requests []*GoogleFirebaseAppcheckV1betaUpdateServiceRequest `json:"requests,omitempty"`
	// UpdateMask: Optional. A comma-separated list of names of fields in the
	// Services to update. Example: `display_name`. If this field is present, the
	// `update_mask` field in the UpdateServiceRequest messages must all match this
	// field, or the entire batch fails and no updates will be committed.
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Requests") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Requests") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest: Request message for the BatchUpdateServices method.

func (*GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse

type GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse struct {
	// Services: Service objects after the updates have been applied.
	Services []*GoogleFirebaseAppcheckV1betaService `json:"services,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Services") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Services") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse: Response message for the BatchUpdateServices method.

func (*GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaDebugToken

type GoogleFirebaseAppcheckV1betaDebugToken struct {
	// DisplayName: Required. A human readable display name used to identify this
	// debug token.
	DisplayName string `json:"displayName,omitempty"`
	// Name: Required. The relative resource name of the debug token, in the
	// format: “`
	// projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} “`
	Name string `json:"name,omitempty"`
	// Token: Required. Input only. Immutable. The secret token itself. Must be
	// provided during creation, and must be a UUID4, case insensitive. This field
	// is immutable once set, and cannot be provided during an UpdateDebugToken
	// request. You can, however, delete this debug token using DeleteDebugToken to
	// revoke it. For security reasons, this field will never be populated in any
	// response.
	Token string `json:"token,omitempty"`
	// UpdateTime: Output only. Timestamp when this debug token was most recently
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (*GoogleFirebaseAppcheckV1betaDebugToken) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaDebugToken) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaDeviceCheckConfig

type GoogleFirebaseAppcheckV1betaDeviceCheckConfig struct {
	// KeyId: Required. The key identifier of a private key enabled with
	// DeviceCheck, created in your Apple Developer account.
	KeyId string `json:"keyId,omitempty"`
	// Name: Required. The relative resource name of the DeviceCheck configuration
	// object, in the format: “`
	// projects/{project_number}/apps/{app_id}/deviceCheckConfig “`
	Name string `json:"name,omitempty"`
	// PrivateKey: Required. Input only. The contents of the private key (`.p8`)
	// file associated with the key specified by `key_id`. For security reasons,
	// this field will never be populated in any response.
	PrivateKey string `json:"privateKey,omitempty"`
	// PrivateKeySet: Output only. Whether the `private_key` field was previously
	// set. Since we will never return the `private_key` field, this field is the
	// only way to find out whether it was previously set.
	PrivateKeySet bool `json:"privateKeySet,omitempty"`
	// TokenTtl: Specifies the duration for which App Check tokens exchanged from
	// DeviceCheck tokens will be valid. If unset, a default value of 1 hour is
	// assumed. Must be between 30 minutes and 7 days, inclusive.
	TokenTtl string `json:"tokenTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "KeyId") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KeyId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps/patch).

func (*GoogleFirebaseAppcheckV1betaDeviceCheckConfig) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest added in v0.49.0

type GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest struct {
	// Artifact: Required. The artifact returned by a previous call to
	// ExchangeAppAttestAttestation.
	Artifact string `json:"artifact,omitempty"`
	// Assertion: Required. The CBOR-encoded assertion returned by the client-side
	// App Attest API.
	Assertion string `json:"assertion,omitempty"`
	// Challenge: Required. A one-time challenge returned by an immediately prior
	// call to GenerateAppAttestChallenge.
	Challenge string `json:"challenge,omitempty"`
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Artifact") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Artifact") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest: Request message for the ExchangeAppAttestAssertion method.

func (*GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest) MarshalJSON added in v0.49.0

type GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest added in v0.49.0

type GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest struct {
	// AttestationStatement: Required. The App Attest statement returned by the
	// client-side App Attest API. This is a base64url encoded CBOR object in the
	// JSON response.
	AttestationStatement string `json:"attestationStatement,omitempty"`
	// Challenge: Required. A one-time challenge returned by an immediately prior
	// call to GenerateAppAttestChallenge.
	Challenge string `json:"challenge,omitempty"`
	// KeyId: Required. The key ID generated by App Attest for the client app.
	KeyId string `json:"keyId,omitempty"`
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttestationStatement") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AttestationStatement") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest: Request message for the ExchangeAppAttestAttestation method.

func (*GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest) MarshalJSON added in v0.49.0

type GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse added in v0.49.0

type GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse struct {
	// AppCheckToken: Encapsulates an App Check token.
	AppCheckToken *GoogleFirebaseAppcheckV1betaAppCheckToken `json:"appCheckToken,omitempty"`
	// Artifact: An artifact that can be used in future calls to
	// ExchangeAppAttestAssertion.
	Artifact string `json:"artifact,omitempty"`
	// AttestationToken: Encapsulates an App Check token.
	AttestationToken *GoogleFirebaseAppcheckV1betaAttestationTokenResponse `json:"attestationToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppCheckToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppCheckToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse: Response message for the ExchangeAppAttestAttestation method.

func (*GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse) MarshalJSON added in v0.49.0

type GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest struct {
	// CustomToken: Required. A custom token signed using your project's Admin SDK
	// service account credentials.
	CustomToken string `json:"customToken,omitempty"`
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest: Request message for the ExchangeCustomToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest struct {
	// DebugToken: Required. A debug token secret. This string must match a debug
	// token secret previously created using CreateDebugToken.
	DebugToken string `json:"debugToken,omitempty"`
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DebugToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DebugToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest: Request message for the ExchangeDebugToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest struct {
	// DeviceToken: Required. The `device_token` as returned by Apple's client-side
	// DeviceCheck API
	// (https://developer.apple.com/documentation/devicecheck/dcdevice). This is
	// the base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
	DeviceToken string `json:"deviceToken,omitempty"`
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeviceToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DeviceToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest: Request message for the ExchangeDeviceCheckToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest added in v0.78.0

type GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest struct {
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// PlayIntegrityToken: Required. The integrity verdict response token from Play
	// Integrity
	// (https://developer.android.com/google/play/integrity/verdict#decrypt-verify)
	// issued to your app.
	PlayIntegrityToken string `json:"playIntegrityToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LimitedUse") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LimitedUse") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest: Request message for the ExchangePlayIntegrityToken method.

func (*GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest) MarshalJSON added in v0.78.0

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest added in v0.61.0

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest struct {
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// RecaptchaEnterpriseToken: Required. The reCAPTCHA token as returned by the
	// reCAPTCHA Enterprise JavaScript API
	// (https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages).
	RecaptchaEnterpriseToken string `json:"recaptchaEnterpriseToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LimitedUse") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LimitedUse") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest: Request message for the ExchangeRecaptchaEnterpriseToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest) MarshalJSON added in v0.61.0

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest struct {
	// RecaptchaToken: Required. The reCAPTCHA token as returned by the reCAPTCHA
	// v3 JavaScript API (https://developers.google.com/recaptcha/docs/v3).
	RecaptchaToken string `json:"recaptchaToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RecaptchaToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RecaptchaToken") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest: Request message for the ExchangeRecaptchaToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest added in v0.73.0

type GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest struct {
	// LimitedUse: Specifies whether this attestation is for use in a *limited use*
	// (`true`) or *session based* (`false`) context. To enable this attestation to
	// be used with the *replay protection* feature, set this to `true`. The
	// default value is `false`.
	LimitedUse bool `json:"limitedUse,omitempty"`
	// RecaptchaV3Token: Required. The reCAPTCHA token as returned by the reCAPTCHA
	// v3 JavaScript API (https://developers.google.com/recaptcha/docs/v3).
	RecaptchaV3Token string `json:"recaptchaV3Token,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LimitedUse") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LimitedUse") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest: Request message for the ExchangeRecaptchaV3Token method.

func (*GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest) MarshalJSON added in v0.73.0

type GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest

type GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest struct {
	// SafetyNetToken: Required. The SafetyNet attestation response
	// (https://developer.android.com/training/safetynet/attestation#request-attestation-step)
	// issued to your app.
	SafetyNetToken string `json:"safetyNetToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SafetyNetToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SafetyNetToken") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest: Request message for the ExchangeSafetyNetToken method.

func (*GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest added in v0.49.0

type GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest struct {
}

GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest: Request message for the GenerateAppAttestChallenge method.

type GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse added in v0.73.0

type GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse struct {
	// Challenge: A one-time use challenge for the client to pass to the App Attest
	// API.
	Challenge string `json:"challenge,omitempty"`
	// Ttl: The duration from the time this challenge is minted until its
	// expiration. This field is intended to ease client-side token management,
	// since the client may have clock skew, but is still able to accurately
	// measure a duration.
	Ttl string `json:"ttl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Challenge") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Challenge") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse: Response message for the GenerateAppAttestChallenge method.

func (*GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse) MarshalJSON added in v0.73.0

type GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest added in v0.78.0

type GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest struct {
}

GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest: Request message for the GeneratePlayIntegrityChallenge method.

type GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse added in v0.78.0

type GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse struct {
	// Challenge: A one-time use challenge
	// (https://developer.android.com/google/play/integrity/verdict#protect-against-replay-attacks)
	// for the client to pass to the Play Integrity API.
	Challenge string `json:"challenge,omitempty"`
	// Ttl: The duration from the time this challenge is minted until its
	// expiration. This field is intended to ease client-side token management,
	// since the client may have clock skew, but is still able to accurately
	// measure a duration.
	Ttl string `json:"ttl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Challenge") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Challenge") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse: Response message for the GeneratePlayIntegrityChallenge method.

func (*GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse) MarshalJSON added in v0.78.0

type GoogleFirebaseAppcheckV1betaListDebugTokensResponse

type GoogleFirebaseAppcheckV1betaListDebugTokensResponse struct {
	// DebugTokens: The DebugTokens retrieved.
	DebugTokens []*GoogleFirebaseAppcheckV1betaDebugToken `json:"debugTokens,omitempty"`
	// NextPageToken: If the result list is too large to fit in a single response,
	// then a token is returned. If the string is empty or omitted, then this
	// response is the last page of results. This token can be used in a subsequent
	// call to ListDebugTokens to find the next group of DebugTokens. Page tokens
	// are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DebugTokens") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DebugTokens") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaListDebugTokensResponse: Response message for the ListDebugTokens method.

func (*GoogleFirebaseAppcheckV1betaListDebugTokensResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse added in v0.154.0

type GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse struct {
	// NextPageToken: If the result list is too large to fit in a single response,
	// then a token is returned. If the string is empty or omitted, then this
	// response is the last page of results. This token can be used in a subsequent
	// call to ListResourcePolicies to find the next group of ResourcePolicy
	// objects. Page tokens are short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ResourcePolicies: The ResourcePolicy objects retrieved.
	ResourcePolicies []*GoogleFirebaseAppcheckV1betaResourcePolicy `json:"resourcePolicies,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse: Response message for the ListResourcePolicies method.

func (*GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse) MarshalJSON added in v0.154.0

type GoogleFirebaseAppcheckV1betaListServicesResponse

type GoogleFirebaseAppcheckV1betaListServicesResponse struct {
	// NextPageToken: If the result list is too large to fit in a single response,
	// then a token is returned. If the string is empty or omitted, then this
	// response is the last page of results. This token can be used in a subsequent
	// call to ListServices to find the next group of Services. Page tokens are
	// short-lived and should not be persisted.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Services: The Services retrieved.
	Services []*GoogleFirebaseAppcheckV1betaService `json:"services,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaListServicesResponse: Response message for the ListServices method.

func (*GoogleFirebaseAppcheckV1betaListServicesResponse) MarshalJSON

type GoogleFirebaseAppcheckV1betaPlayIntegrityConfig added in v0.78.0

type GoogleFirebaseAppcheckV1betaPlayIntegrityConfig struct {
	// Name: Required. The relative resource name of the Play Integrity
	// configuration object, in the format: “`
	// projects/{project_number}/apps/{app_id}/playIntegrityConfig “`
	Name string `json:"name,omitempty"`
	// TokenTtl: Specifies the duration for which App Check tokens exchanged from
	// Play Integrity tokens will be valid. If unset, a default value of 1 hour is
	// assumed. Must be between 30 minutes and 7 days, inclusive.
	TokenTtl string `json:"tokenTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).

func (*GoogleFirebaseAppcheckV1betaPlayIntegrityConfig) MarshalJSON added in v0.78.0

type GoogleFirebaseAppcheckV1betaPublicJwk

type GoogleFirebaseAppcheckV1betaPublicJwk struct {
	// Alg: See section 4.4 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.4).
	Alg string `json:"alg,omitempty"`
	// E: See section 6.3.1.2 of RFC 7518
	// (https://tools.ietf.org/html/rfc7518#section-6.3.1.2).
	E string `json:"e,omitempty"`
	// Kid: See section 4.5 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.5).
	Kid string `json:"kid,omitempty"`
	// Kty: See section 4.1 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.1).
	Kty string `json:"kty,omitempty"`
	// N: See section 6.3.1.1 of RFC 7518
	// (https://tools.ietf.org/html/rfc7518#section-6.3.1.1).
	N string `json:"n,omitempty"`
	// Use: See section 4.2 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-4.2).
	Use string `json:"use,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Alg") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Alg") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaPublicJwk: A JWK as specified by section 4 of RFC 7517 (https://tools.ietf.org/html/rfc7517#section-4) and section 6.3.1 of RFC 7518 (https://tools.ietf.org/html/rfc7518#section-6.3.1).

func (*GoogleFirebaseAppcheckV1betaPublicJwk) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaPublicJwk) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaPublicJwkSet

type GoogleFirebaseAppcheckV1betaPublicJwkSet struct {
	// Keys: The set of public keys. See section 5.1 of RFC 7517
	// (https://tools.ietf.org/html/rfc7517#section-5).
	Keys []*GoogleFirebaseAppcheckV1betaPublicJwk `json:"keys,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Keys") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Keys") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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 (https://tools.ietf.org/html/rfc7517#section-5). For security, the response **must not** be cached for longer than six hours.

func (*GoogleFirebaseAppcheckV1betaPublicJwkSet) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaPublicJwkSet) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaRecaptchaConfig

type GoogleFirebaseAppcheckV1betaRecaptchaConfig struct {
	// Name: Required. The relative resource name of the reCAPTCHA v3 configuration
	// object, in the format: “`
	// projects/{project_number}/apps/{app_id}/recaptchaConfig “`
	Name string `json:"name,omitempty"`
	// SiteSecret: Required. Input only. The site secret used to identify your
	// service for reCAPTCHA v3 verification. For security reasons, this field will
	// never be populated in any response.
	SiteSecret string `json:"siteSecret,omitempty"`
	// SiteSecretSet: Output only. Whether the `site_secret` field was previously
	// set. Since we will never return the `site_secret` field, this field is the
	// only way to find out whether it was previously set.
	SiteSecretSet bool `json:"siteSecretSet,omitempty"`
	// TokenTtl: Specifies the duration for which App Check tokens exchanged from
	// reCAPTCHA tokens will be valid. If unset, a default value of 1 day is
	// assumed. Must be between 30 minutes and 7 days, inclusive.
	TokenTtl string `json:"tokenTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (*GoogleFirebaseAppcheckV1betaRecaptchaConfig) MarshalJSON

type GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig added in v0.61.0

type GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig struct {
	// Name: Required. The relative resource name of the reCAPTCHA Enterprise
	// configuration object, in the format: “`
	// projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig “`
	Name string `json:"name,omitempty"`
	// SiteKey: The score-based site key created in reCAPTCHA Enterprise
	// (https://cloud.google.com/recaptcha-enterprise/docs/create-key#creating_a_site_key)
	// used to invoke reCAPTCHA and generate the reCAPTCHA tokens
	// (https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages)
	// for your application. Important: This is *not* the `site_secret` (as it is
	// in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
	SiteKey string `json:"siteKey,omitempty"`
	// TokenTtl: Specifies the duration for which App Check tokens exchanged from
	// reCAPTCHA Enterprise tokens will be valid. If unset, a default value of 1
	// hour is assumed. Must be between 30 minutes and 7 days, inclusive.
	TokenTtl string `json:"tokenTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (*GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig) MarshalJSON added in v0.61.0

type GoogleFirebaseAppcheckV1betaRecaptchaV3Config added in v0.74.0

type GoogleFirebaseAppcheckV1betaRecaptchaV3Config struct {
	// Name: Required. The relative resource name of the reCAPTCHA v3 configuration
	// object, in the format: “`
	// projects/{project_number}/apps/{app_id}/recaptchaV3Config “`
	Name string `json:"name,omitempty"`
	// SiteSecret: Required. Input only. The site secret used to identify your
	// service for reCAPTCHA v3 verification. For security reasons, this field will
	// never be populated in any response.
	SiteSecret string `json:"siteSecret,omitempty"`
	// SiteSecretSet: Output only. Whether the `site_secret` field was previously
	// set. Since we will never return the `site_secret` field, this field is the
	// only way to find out whether it was previously set.
	SiteSecretSet bool `json:"siteSecretSet,omitempty"`
	// TokenTtl: Specifies the duration for which App Check tokens exchanged from
	// reCAPTCHA tokens will be valid. If unset, a default value of 1 day is
	// assumed. Must be between 30 minutes and 7 days, inclusive.
	TokenTtl string `json:"tokenTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (*GoogleFirebaseAppcheckV1betaRecaptchaV3Config) MarshalJSON added in v0.74.0

type GoogleFirebaseAppcheckV1betaResourcePolicy added in v0.154.0

type GoogleFirebaseAppcheckV1betaResourcePolicy struct {
	// EnforcementMode: Required. The App Check enforcement mode for this resource.
	// This will override the EnforcementMode setting on the parent service.
	//
	// Possible values:
	//   "OFF" - Firebase App Check is not enforced for the service, nor are App
	// Check metrics collected. Though the service is not protected by App Check in
	// this mode, other applicable protections, such as user authorization, are
	// still enforced. An unconfigured service is in this mode by default.
	//   "UNENFORCED" - Firebase App Check is not enforced for the service. App
	// Check metrics are collected to help you decide when to turn on enforcement
	// for the service. Though the service is not protected by App Check in this
	// mode, other applicable protections, such as user authorization, are still
	// enforced. Some services require certain conditions to be met before they
	// will work with App Check, such as requiring you to upgrade to a specific
	// service tier. Until those requirements are met for a service, this
	// `UNENFORCED` setting will have no effect and App Check will not work with
	// that service.
	//   "ENFORCED" - Firebase App Check is enforced for the service. The service
	// will reject any request that attempts to access your project's resources if
	// it does not have valid App Check token attached, with some exceptions
	// depending on the service; for example, some services will still allow
	// requests bearing the developer's privileged service account credentials
	// without an App Check token. App Check metrics continue to be collected to
	// help you detect issues with your App Check integration and monitor the
	// composition of your callers. While the service is protected by App Check,
	// other applicable protections, such as user authorization, continue to be
	// enforced at the same time. Use caution when choosing to enforce App Check on
	// a Firebase service. If your users have not updated to an App Check capable
	// version of your app, their apps will no longer be able to use your Firebase
	// services that are enforcing App Check. App Check metrics can help you decide
	// whether to enforce App Check on your Firebase services. If your app has not
	// launched yet, you should enable enforcement immediately, since there are no
	// outdated clients in use. Some services require certain conditions to be met
	// before they will work with App Check, such as requiring you to upgrade to a
	// specific service tier. Until those requirements are met for a service, this
	// `ENFORCED` setting will have no effect and App Check will not work with that
	// service.
	EnforcementMode string `json:"enforcementMode,omitempty"`
	// Etag: This checksum is computed by the server based on the value of other
	// fields, and may be sent on update and delete requests to ensure the client
	// has an up-to-date value before proceeding. This etag is strongly validated
	// as defined by RFC 7232.
	Etag string `json:"etag,omitempty"`
	// Name: Required. The relative name of the resource policy object, in the
	// format: “`
	// projects/{project_number}/services/{service_id}/resourcePolicies/{resource_po
	// licy_id} “` Note that the `service_id` element must be a supported service
	// ID. Currently, the following service IDs are supported: *
	// `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a
	// system-generated UID.
	Name string `json:"name,omitempty"`
	// TargetResource: Required. Service specific name of the resource object to
	// which this policy applies, in the format: *
	// `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client
	// _id}` (Google Identity for iOS) Note that the resource must belong to the
	// service specified in the `name` and be from the same project as this policy,
	// but the resource is allowed to be missing at the time of creation of this
	// policy; in that case, we make a best-effort attempt at respecting this
	// policy, but it may not have any effect until the resource is fully created.
	TargetResource string `json:"targetResource,omitempty"`
	// UpdateTime: Output only. Timestamp when this resource policy configuration
	// object was most recently updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EnforcementMode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnforcementMode") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleFirebaseAppcheckV1betaResourcePolicy) MarshalJSON added in v0.154.0

type GoogleFirebaseAppcheckV1betaSafetyNetConfig added in v0.51.0

type GoogleFirebaseAppcheckV1betaSafetyNetConfig struct {
	// Name: Required. The relative resource name of the SafetyNet configuration
	// object, in the format: “`
	// projects/{project_number}/apps/{app_id}/safetyNetConfig “`
	Name string `json:"name,omitempty"`
	// TokenTtl: Specifies the duration for which App Check tokens exchanged from
	// SafetyNet tokens will be valid. If unset, a default value of 1 hour is
	// assumed. Must be between 30 minutes and 7 days, inclusive.
	TokenTtl string `json:"tokenTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaSafetyNetConfig: An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the Firebase Management Service (https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).

func (*GoogleFirebaseAppcheckV1betaSafetyNetConfig) MarshalJSON added in v0.51.0

type GoogleFirebaseAppcheckV1betaService

type GoogleFirebaseAppcheckV1betaService struct {
	// EnforcementMode: Required. The App Check enforcement mode for this service.
	//
	// Possible values:
	//   "OFF" - Firebase App Check is not enforced for the service, nor are App
	// Check metrics collected. Though the service is not protected by App Check in
	// this mode, other applicable protections, such as user authorization, are
	// still enforced. An unconfigured service is in this mode by default.
	//   "UNENFORCED" - Firebase App Check is not enforced for the service. App
	// Check metrics are collected to help you decide when to turn on enforcement
	// for the service. Though the service is not protected by App Check in this
	// mode, other applicable protections, such as user authorization, are still
	// enforced. Some services require certain conditions to be met before they
	// will work with App Check, such as requiring you to upgrade to a specific
	// service tier. Until those requirements are met for a service, this
	// `UNENFORCED` setting will have no effect and App Check will not work with
	// that service.
	//   "ENFORCED" - Firebase App Check is enforced for the service. The service
	// will reject any request that attempts to access your project's resources if
	// it does not have valid App Check token attached, with some exceptions
	// depending on the service; for example, some services will still allow
	// requests bearing the developer's privileged service account credentials
	// without an App Check token. App Check metrics continue to be collected to
	// help you detect issues with your App Check integration and monitor the
	// composition of your callers. While the service is protected by App Check,
	// other applicable protections, such as user authorization, continue to be
	// enforced at the same time. Use caution when choosing to enforce App Check on
	// a Firebase service. If your users have not updated to an App Check capable
	// version of your app, their apps will no longer be able to use your Firebase
	// services that are enforcing App Check. App Check metrics can help you decide
	// whether to enforce App Check on your Firebase services. If your app has not
	// launched yet, you should enable enforcement immediately, since there are no
	// outdated clients in use. Some services require certain conditions to be met
	// before they will work with App Check, such as requiring you to upgrade to a
	// specific service tier. Until those requirements are met for a service, this
	// `ENFORCED` setting will have no effect and App Check will not work with that
	// service.
	EnforcementMode string `json:"enforcementMode,omitempty"`
	// Etag: This checksum is computed by the server based on the value of other
	// fields, and may be sent on update and delete requests to ensure the client
	// has an up-to-date value before proceeding. This etag is strongly validated
	// as defined by RFC 7232.
	Etag string `json:"etag,omitempty"`
	// Name: Required. The relative resource name of the service configuration
	// object, in the format: “` projects/{project_number}/services/{service_id}
	// “` Note that the `service_id` element must be a supported service ID.
	// Currently, the following service IDs are supported: *
	// `firebasestorage.googleapis.com` (Cloud Storage for Firebase) *
	// `firebasedatabase.googleapis.com` (Firebase Realtime Database) *
	// `firestore.googleapis.com` (Cloud Firestore) *
	// `identitytoolkit.googleapis.com` (Firebase Authentication with Identity
	// Platform)
	Name string `json:"name,omitempty"`
	// UpdateTime: Output only. Timestamp when this service configuration object
	// was most recently updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EnforcementMode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EnforcementMode") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleFirebaseAppcheckV1betaService) MarshalJSON

func (s *GoogleFirebaseAppcheckV1betaService) MarshalJSON() ([]byte, error)

type GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest added in v0.154.0

type GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest struct {
	// ResourcePolicy: Required. The ResourcePolicy to update. The ResourcePolicy's
	// `name` field is used to identify the ResourcePolicy to be updated, in the
	// format: “`
	// projects/{project_number}/services/{service_id}/resourcePolicies/{resource_po
	// licy_id} “` Note that the `service_id` element must be a supported service
	// ID. Currently, the following service IDs are supported: *
	// `oauth2.googleapis.com` (Google Identity for iOS)
	ResourcePolicy *GoogleFirebaseAppcheckV1betaResourcePolicy `json:"resourcePolicy,omitempty"`
	// UpdateMask: Required. A comma-separated list of names of fields in the
	// ResourcePolicy to update. Example: `enforcement_mode`.
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ResourcePolicy") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ResourcePolicy") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest) MarshalJSON added in v0.154.0

type GoogleFirebaseAppcheckV1betaUpdateServiceRequest

type GoogleFirebaseAppcheckV1betaUpdateServiceRequest struct {
	// Service: Required. The Service to update. The Service's `name` field is used
	// to identify the Service to be updated, in the format: “`
	// projects/{project_number}/services/{service_id} “` Note that the
	// `service_id` element must be a supported service ID. Currently, the
	// following service IDs are supported: * `firebasestorage.googleapis.com`
	// (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase
	// Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) *
	// `identitytoolkit.googleapis.com` (Firebase Authentication with Identity
	// Platform) For Firebase Authentication to work with App Check, you must first
	// upgrade to Firebase Authentication with Identity Platform
	// (https://firebase.google.com/docs/auth#identity-platform).
	Service *GoogleFirebaseAppcheckV1betaService `json:"service,omitempty"`
	// UpdateMask: Required. A comma-separated list of names of fields in the
	// Service to update. Example: `enforcement_mode`.
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Service") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Service") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (*GoogleFirebaseAppcheckV1betaUpdateServiceRequest) MarshalJSON

type GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenRequest added in v0.121.0

type GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenRequest struct {
	// AppCheckToken: Required. The App Check token to verify. App Check tokens
	// exchanged from the SafetyNet provider are not supported; an HTTP 400 error
	// will be returned.
	AppCheckToken string `json:"appCheckToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AppCheckToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppCheckToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenRequest: Request message for the VerifyAppCheckToken method.

func (*GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenRequest) MarshalJSON added in v0.121.0

type GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenResponse added in v0.121.0

type GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenResponse struct {
	// AlreadyConsumed: Whether this token was already consumed. If this is the
	// first time this method has seen the given App Check token, this field will
	// be omitted from the response. 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 containing this field,
	// regardless whether the token was already consumed.
	AlreadyConsumed bool `json:"alreadyConsumed,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AlreadyConsumed") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AlreadyConsumed") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenResponse: Response message for the VerifyAppCheckToken method.

func (*GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenResponse) MarshalJSON added in v0.121.0

type GoogleProtobufEmpty

type GoogleProtobufEmpty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

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); }

type JwksGetCall

type JwksGetCall struct {
	// contains filtered or unexported fields
}

func (*JwksGetCall) Context

func (c *JwksGetCall) Context(ctx context.Context) *JwksGetCall

Context sets the context to be used in this call's Do method.

func (*JwksGetCall) Do

Do executes the "firebaseappcheck.jwks.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaPublicJwkSet.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*JwksGetCall) Fields

func (c *JwksGetCall) Fields(s ...googleapi.Field) *JwksGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*JwksGetCall) Header

func (c *JwksGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*JwksGetCall) IfNoneMatch

func (c *JwksGetCall) IfNoneMatch(entityTag string) *JwksGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type JwksService

type JwksService struct {
	// contains filtered or unexported fields
}

func NewJwksService

func NewJwksService(s *Service) *JwksService

func (*JwksService) Get

func (r *JwksService) Get(name string) *JwksGetCall

Get: Returns a public JWK set as specified by RFC 7517 (https://tools.ietf.org/html/rfc7517) 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.

  • name: The relative resource name to the public JWK set. Must always be exactly the string `jwks`.

type OauthClientsExchangeAppAttestAssertionCall added in v0.126.0

type OauthClientsExchangeAppAttestAssertionCall struct {
	// contains filtered or unexported fields
}

func (*OauthClientsExchangeAppAttestAssertionCall) Context added in v0.126.0

Context sets the context to be used in this call's Do method.

func (*OauthClientsExchangeAppAttestAssertionCall) Do added in v0.126.0

Do executes the "firebaseappcheck.oauthClients.exchangeAppAttestAssertion" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OauthClientsExchangeAppAttestAssertionCall) Fields added in v0.126.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OauthClientsExchangeAppAttestAssertionCall) Header added in v0.126.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OauthClientsExchangeAppAttestAttestationCall added in v0.126.0

type OauthClientsExchangeAppAttestAttestationCall struct {
	// contains filtered or unexported fields
}

func (*OauthClientsExchangeAppAttestAttestationCall) Context added in v0.126.0

Context sets the context to be used in this call's Do method.

func (*OauthClientsExchangeAppAttestAttestationCall) Do added in v0.126.0

Do executes the "firebaseappcheck.oauthClients.exchangeAppAttestAttestation" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse.ServerRespo nse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OauthClientsExchangeAppAttestAttestationCall) Fields added in v0.126.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OauthClientsExchangeAppAttestAttestationCall) Header added in v0.126.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OauthClientsExchangeDebugTokenCall added in v0.138.0

type OauthClientsExchangeDebugTokenCall struct {
	// contains filtered or unexported fields
}

func (*OauthClientsExchangeDebugTokenCall) Context added in v0.138.0

Context sets the context to be used in this call's Do method.

func (*OauthClientsExchangeDebugTokenCall) Do added in v0.138.0

Do executes the "firebaseappcheck.oauthClients.exchangeDebugToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OauthClientsExchangeDebugTokenCall) Fields added in v0.138.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OauthClientsExchangeDebugTokenCall) Header added in v0.138.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OauthClientsGenerateAppAttestChallengeCall added in v0.126.0

type OauthClientsGenerateAppAttestChallengeCall struct {
	// contains filtered or unexported fields
}

func (*OauthClientsGenerateAppAttestChallengeCall) Context added in v0.126.0

Context sets the context to be used in this call's Do method.

func (*OauthClientsGenerateAppAttestChallengeCall) Do added in v0.126.0

Do executes the "firebaseappcheck.oauthClients.generateAppAttestChallenge" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse.ServerRespons e.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OauthClientsGenerateAppAttestChallengeCall) Fields added in v0.126.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OauthClientsGenerateAppAttestChallengeCall) Header added in v0.126.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OauthClientsService added in v0.126.0

type OauthClientsService struct {
	// contains filtered or unexported fields
}

func NewOauthClientsService added in v0.126.0

func NewOauthClientsService(s *Service) *OauthClientsService

func (*OauthClientsService) ExchangeAppAttestAssertion added in v0.126.0

func (r *OauthClientsService) ExchangeAppAttestAssertion(appid string, googlefirebaseappcheckv1betaexchangeappattestassertionrequest *GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest) *OauthClientsExchangeAppAttestAssertionCall

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

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

func (*OauthClientsService) ExchangeAppAttestAttestation added in v0.126.0

func (r *OauthClientsService) ExchangeAppAttestAttestation(appid string, googlefirebaseappcheckv1betaexchangeappattestattestationrequest *GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest) *OauthClientsExchangeAppAttestAttestationCall

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

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

func (*OauthClientsService) ExchangeDebugToken added in v0.138.0

func (r *OauthClientsService) ExchangeDebugToken(appid string, googlefirebaseappcheckv1betaexchangedebugtokenrequest *GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest) *OauthClientsExchangeDebugTokenCall

ExchangeDebugToken: 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.

  • app: The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

func (*OauthClientsService) GenerateAppAttestChallenge added in v0.126.0

func (r *OauthClientsService) GenerateAppAttestChallenge(appid string, googlefirebaseappcheckv1betagenerateappattestchallengerequest *GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest) *OauthClientsGenerateAppAttestChallengeCall

GenerateAppAttestChallenge: 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.

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

type ProjectsAppsAppAttestConfigBatchGetCall added in v0.51.0

type ProjectsAppsAppAttestConfigBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsAppAttestConfigBatchGetCall) Context added in v0.51.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsAppAttestConfigBatchGetCall) Do added in v0.51.0

Do executes the "firebaseappcheck.projects.apps.appAttestConfig.batchGet" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse.ServerResponse. Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsAppAttestConfigBatchGetCall) Fields added in v0.51.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsAppAttestConfigBatchGetCall) Header added in v0.51.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsAppAttestConfigBatchGetCall) IfNoneMatch added in v0.51.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsAppAttestConfigBatchGetCall) Names added in v0.51.0

Names sets the optional parameter "names": Required. The relative resource names of the AppAttestConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/appAttestConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsAppAttestConfigGetCall added in v0.51.0

type ProjectsAppsAppAttestConfigGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsAppAttestConfigGetCall) Context added in v0.51.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsAppAttestConfigGetCall) Do added in v0.51.0

Do executes the "firebaseappcheck.projects.apps.appAttestConfig.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppAttestConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsAppAttestConfigGetCall) Fields added in v0.51.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsAppAttestConfigGetCall) Header added in v0.51.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsAppAttestConfigGetCall) IfNoneMatch added in v0.51.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsAppAttestConfigPatchCall added in v0.51.0

type ProjectsAppsAppAttestConfigPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsAppAttestConfigPatchCall) Context added in v0.51.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsAppAttestConfigPatchCall) Do added in v0.51.0

Do executes the "firebaseappcheck.projects.apps.appAttestConfig.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppAttestConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsAppAttestConfigPatchCall) Fields added in v0.51.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsAppAttestConfigPatchCall) Header added in v0.51.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsAppAttestConfigPatchCall) UpdateMask added in v0.51.0

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the AppAttestConfig to update. Example: `token_ttl`.

type ProjectsAppsAppAttestConfigService added in v0.51.0

type ProjectsAppsAppAttestConfigService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsAppAttestConfigService added in v0.51.0

func NewProjectsAppsAppAttestConfigService(s *Service) *ProjectsAppsAppAttestConfigService

func (*ProjectsAppsAppAttestConfigService) BatchGet added in v0.51.0

BatchGet: Atomically gets the AppAttestConfigs for the specified list of apps.

  • parent: The parent project name shared by all AppAttestConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsAppAttestConfigService) Get added in v0.51.0

Get: Gets the AppAttestConfig for the specified app.

  • name: The relative resource name of the AppAttestConfig, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```.

func (*ProjectsAppsAppAttestConfigService) Patch added in v0.51.0

Patch: 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.

  • name: The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```.

type ProjectsAppsDebugTokensCreateCall

type ProjectsAppsDebugTokensCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDebugTokensCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDebugTokensCreateCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDebugToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDebugTokensCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsDebugTokensDeleteCall

type ProjectsAppsDebugTokensDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDebugTokensDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDebugTokensDeleteCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDebugTokensDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsDebugTokensGetCall

type ProjectsAppsDebugTokensGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDebugTokensGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDebugTokensGetCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDebugToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDebugTokensGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsDebugTokensGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsDebugTokensListCall

type ProjectsAppsDebugTokensListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDebugTokensListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDebugTokensListCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaListDebugTokensResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDebugTokensListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsDebugTokensListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsDebugTokensListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of DebugTokens to return in the response. Note that an app can have at most 20 debug tokens. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

func (*ProjectsAppsDebugTokensListCall) PageToken

PageToken sets the optional parameter "pageToken": Token returned from a previous call to ListDebugTokens indicating where in the set of DebugTokens to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDebugTokens must match the call that provided the page token; if they do not match, the result is undefined.

func (*ProjectsAppsDebugTokensListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsAppsDebugTokensPatchCall

type ProjectsAppsDebugTokensPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDebugTokensPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDebugTokensPatchCall) Do

Do executes the "firebaseappcheck.projects.apps.debugTokens.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDebugToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDebugTokensPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDebugTokensPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsDebugTokensPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the DebugToken to update. Example: `display_name`.

type ProjectsAppsDebugTokensService

type ProjectsAppsDebugTokensService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsDebugTokensService

func NewProjectsAppsDebugTokensService(s *Service) *ProjectsAppsDebugTokensService

func (*ProjectsAppsDebugTokensService) Create

func (r *ProjectsAppsDebugTokensService) Create(parent string, googlefirebaseappcheckv1betadebugtoken *GoogleFirebaseAppcheckV1betaDebugToken) *ProjectsAppsDebugTokensCreateCall

Create: 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.

  • parent: The relative resource name of the parent app in which the specified DebugToken will be created, in the format: ``` projects/{project_number}/apps/{app_id} ```.

func (*ProjectsAppsDebugTokensService) Delete

Delete: 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.

  • name: The relative resource name of the DebugToken to delete, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```.

func (*ProjectsAppsDebugTokensService) Get

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

  • name: The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```.

func (*ProjectsAppsDebugTokensService) List

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

  • parent: The relative resource name of the parent app for which to list each associated DebugToken, in the format: ``` projects/{project_number}/apps/{app_id} ```.

func (*ProjectsAppsDebugTokensService) Patch

Patch: 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.

  • name: The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```.

type ProjectsAppsDeviceCheckConfigBatchGetCall

type ProjectsAppsDeviceCheckConfigBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Do

Do executes the "firebaseappcheck.projects.apps.deviceCheckConfig.batchGet" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse.ServerRespons e.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsDeviceCheckConfigBatchGetCall) Names

Names sets the optional parameter "names": Required. The relative resource names of the DeviceCheckConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsDeviceCheckConfigGetCall

type ProjectsAppsDeviceCheckConfigGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDeviceCheckConfigGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDeviceCheckConfigGetCall) Do

Do executes the "firebaseappcheck.projects.apps.deviceCheckConfig.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDeviceCheckConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDeviceCheckConfigGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDeviceCheckConfigGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsDeviceCheckConfigGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsDeviceCheckConfigPatchCall

type ProjectsAppsDeviceCheckConfigPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsDeviceCheckConfigPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsDeviceCheckConfigPatchCall) Do

Do executes the "firebaseappcheck.projects.apps.deviceCheckConfig.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaDeviceCheckConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsDeviceCheckConfigPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsDeviceCheckConfigPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsDeviceCheckConfigPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the DeviceCheckConfig to update. Example: `key_id,private_key`.

type ProjectsAppsDeviceCheckConfigService

type ProjectsAppsDeviceCheckConfigService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsDeviceCheckConfigService

func NewProjectsAppsDeviceCheckConfigService(s *Service) *ProjectsAppsDeviceCheckConfigService

func (*ProjectsAppsDeviceCheckConfigService) BatchGet

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

  • parent: The parent project name shared by all DeviceCheckConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsDeviceCheckConfigService) Get

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

  • name: The relative resource name of the DeviceCheckConfig, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ```.

func (*ProjectsAppsDeviceCheckConfigService) Patch

Patch: 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.

  • name: The relative resource name of the DeviceCheck configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ```.

type ProjectsAppsExchangeAppAttestAssertionCall added in v0.49.0

type ProjectsAppsExchangeAppAttestAssertionCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeAppAttestAssertionCall) Context added in v0.49.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeAppAttestAssertionCall) Do added in v0.49.0

Do executes the "firebaseappcheck.projects.apps.exchangeAppAttestAssertion" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeAppAttestAssertionCall) Fields added in v0.49.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeAppAttestAssertionCall) Header added in v0.49.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeAppAttestAttestationCall added in v0.49.0

type ProjectsAppsExchangeAppAttestAttestationCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeAppAttestAttestationCall) Context added in v0.49.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeAppAttestAttestationCall) Do added in v0.49.0

Do executes the "firebaseappcheck.projects.apps.exchangeAppAttestAttestation" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationResponse.ServerRespo nse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeAppAttestAttestationCall) Fields added in v0.49.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeAppAttestAttestationCall) Header added in v0.49.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeCustomTokenCall

type ProjectsAppsExchangeCustomTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeCustomTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeCustomTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeCustomToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeCustomTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeCustomTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeDebugTokenCall

type ProjectsAppsExchangeDebugTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeDebugTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeDebugTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeDebugToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeDebugTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeDebugTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeDeviceCheckTokenCall

type ProjectsAppsExchangeDeviceCheckTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeDeviceCheckToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeDeviceCheckTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangePlayIntegrityTokenCall added in v0.78.0

type ProjectsAppsExchangePlayIntegrityTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangePlayIntegrityTokenCall) Context added in v0.78.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangePlayIntegrityTokenCall) Do added in v0.78.0

Do executes the "firebaseappcheck.projects.apps.exchangePlayIntegrityToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangePlayIntegrityTokenCall) Fields added in v0.78.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangePlayIntegrityTokenCall) Header added in v0.78.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeRecaptchaEnterpriseTokenCall added in v0.61.0

type ProjectsAppsExchangeRecaptchaEnterpriseTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeRecaptchaEnterpriseTokenCall) Context added in v0.61.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeRecaptchaEnterpriseTokenCall) Do added in v0.61.0

Do executes the "firebaseappcheck.projects.apps.exchangeRecaptchaEnterpriseToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeRecaptchaEnterpriseTokenCall) Fields added in v0.61.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeRecaptchaEnterpriseTokenCall) Header added in v0.61.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeRecaptchaTokenCall

type ProjectsAppsExchangeRecaptchaTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeRecaptchaTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeRecaptchaTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeRecaptchaToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeRecaptchaTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeRecaptchaTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeRecaptchaV3TokenCall added in v0.73.0

type ProjectsAppsExchangeRecaptchaV3TokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeRecaptchaV3TokenCall) Context added in v0.73.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeRecaptchaV3TokenCall) Do added in v0.73.0

Do executes the "firebaseappcheck.projects.apps.exchangeRecaptchaV3Token" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeRecaptchaV3TokenCall) Fields added in v0.73.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeRecaptchaV3TokenCall) Header added in v0.73.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsExchangeSafetyNetTokenCall

type ProjectsAppsExchangeSafetyNetTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsExchangeSafetyNetTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsExchangeSafetyNetTokenCall) Do

Do executes the "firebaseappcheck.projects.apps.exchangeSafetyNetToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaAppCheckToken.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsExchangeSafetyNetTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsExchangeSafetyNetTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsGenerateAppAttestChallengeCall added in v0.49.0

type ProjectsAppsGenerateAppAttestChallengeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsGenerateAppAttestChallengeCall) Context added in v0.49.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsGenerateAppAttestChallengeCall) Do added in v0.49.0

Do executes the "firebaseappcheck.projects.apps.generateAppAttestChallenge" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeResponse.ServerRespons e.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsGenerateAppAttestChallengeCall) Fields added in v0.49.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsGenerateAppAttestChallengeCall) Header added in v0.49.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsGeneratePlayIntegrityChallengeCall added in v0.78.0

type ProjectsAppsGeneratePlayIntegrityChallengeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsGeneratePlayIntegrityChallengeCall) Context added in v0.78.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsGeneratePlayIntegrityChallengeCall) Do added in v0.78.0

Do executes the "firebaseappcheck.projects.apps.generatePlayIntegrityChallenge" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeResponse.ServerRes ponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsGeneratePlayIntegrityChallengeCall) Fields added in v0.78.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsGeneratePlayIntegrityChallengeCall) Header added in v0.78.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsAppsPlayIntegrityConfigBatchGetCall added in v0.78.0

type ProjectsAppsPlayIntegrityConfigBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsPlayIntegrityConfigBatchGetCall) Context added in v0.78.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsPlayIntegrityConfigBatchGetCall) Do added in v0.78.0

Do executes the "firebaseappcheck.projects.apps.playIntegrityConfig.batchGet" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetPlayIntegrityConfigsResponse.ServerRespo nse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsPlayIntegrityConfigBatchGetCall) Fields added in v0.78.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsPlayIntegrityConfigBatchGetCall) Header added in v0.78.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsPlayIntegrityConfigBatchGetCall) IfNoneMatch added in v0.78.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsPlayIntegrityConfigBatchGetCall) Names added in v0.78.0

Names sets the optional parameter "names": Required. The relative resource names of the PlayIntegrityConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsPlayIntegrityConfigGetCall added in v0.78.0

type ProjectsAppsPlayIntegrityConfigGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsPlayIntegrityConfigGetCall) Context added in v0.78.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsPlayIntegrityConfigGetCall) Do added in v0.78.0

Do executes the "firebaseappcheck.projects.apps.playIntegrityConfig.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaPlayIntegrityConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsPlayIntegrityConfigGetCall) Fields added in v0.78.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsPlayIntegrityConfigGetCall) Header added in v0.78.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsPlayIntegrityConfigGetCall) IfNoneMatch added in v0.78.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsPlayIntegrityConfigPatchCall added in v0.78.0

type ProjectsAppsPlayIntegrityConfigPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsPlayIntegrityConfigPatchCall) Context added in v0.78.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsPlayIntegrityConfigPatchCall) Do added in v0.78.0

Do executes the "firebaseappcheck.projects.apps.playIntegrityConfig.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaPlayIntegrityConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsPlayIntegrityConfigPatchCall) Fields added in v0.78.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsPlayIntegrityConfigPatchCall) Header added in v0.78.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsPlayIntegrityConfigPatchCall) UpdateMask added in v0.78.0

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the PlayIntegrityConfig to update. Example: `token_ttl`.

type ProjectsAppsPlayIntegrityConfigService added in v0.78.0

type ProjectsAppsPlayIntegrityConfigService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsPlayIntegrityConfigService added in v0.78.0

func NewProjectsAppsPlayIntegrityConfigService(s *Service) *ProjectsAppsPlayIntegrityConfigService

func (*ProjectsAppsPlayIntegrityConfigService) BatchGet added in v0.78.0

BatchGet: Atomically gets the PlayIntegrityConfigs for the specified list of apps.

  • parent: The parent project name shared by all PlayIntegrityConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsPlayIntegrityConfigService) Get added in v0.78.0

Get: Gets the PlayIntegrityConfig for the specified app.

  • name: The relative resource name of the PlayIntegrityConfig, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```.

func (*ProjectsAppsPlayIntegrityConfigService) Patch added in v0.78.0

Patch: 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.

  • name: The relative resource name of the Play Integrity configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/playIntegrityConfig ```.

type ProjectsAppsRecaptchaConfigBatchGetCall

type ProjectsAppsRecaptchaConfigBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Do

Do executes the "firebaseappcheck.projects.apps.recaptchaConfig.batchGet" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse.ServerResponse. Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsRecaptchaConfigBatchGetCall) Names

Names sets the optional parameter "names": Required. The relative resource names of the RecaptchaConfigs to retrieve, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsRecaptchaConfigGetCall

type ProjectsAppsRecaptchaConfigGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaConfigGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaConfigGetCall) Do

Do executes the "firebaseappcheck.projects.apps.recaptchaConfig.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaConfigGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaConfigGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaConfigGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsRecaptchaConfigPatchCall

type ProjectsAppsRecaptchaConfigPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaConfigPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaConfigPatchCall) Do

Do executes the "firebaseappcheck.projects.apps.recaptchaConfig.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaConfigPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaConfigPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaConfigPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the RecaptchaConfig to update. Example: `site_secret`.

type ProjectsAppsRecaptchaConfigService

type ProjectsAppsRecaptchaConfigService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsRecaptchaConfigService

func NewProjectsAppsRecaptchaConfigService(s *Service) *ProjectsAppsRecaptchaConfigService

func (*ProjectsAppsRecaptchaConfigService) BatchGet

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

  • parent: The parent project name shared by all RecaptchaConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsRecaptchaConfigService) Get

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

  • name: The relative resource name of the RecaptchaConfig, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ```.

func (*ProjectsAppsRecaptchaConfigService) Patch

Patch: 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.

  • name: The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ```.

type ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall added in v0.61.0

type ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall) Context added in v0.61.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall) Do added in v0.61.0

Do executes the "firebaseappcheck.projects.apps.recaptchaEnterpriseConfig.batchGet" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetRecaptchaEnterpriseConfigsResponse.Serve rResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall) Fields added in v0.61.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall) Header added in v0.61.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall) IfNoneMatch added in v0.61.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsRecaptchaEnterpriseConfigBatchGetCall) Names added in v0.61.0

Names sets the optional parameter "names": Required. The relative resource names of the RecaptchaEnterpriseConfigs to retrieve, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsRecaptchaEnterpriseConfigGetCall added in v0.61.0

type ProjectsAppsRecaptchaEnterpriseConfigGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaEnterpriseConfigGetCall) Context added in v0.61.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaEnterpriseConfigGetCall) Do added in v0.61.0

Do executes the "firebaseappcheck.projects.apps.recaptchaEnterpriseConfig.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaEnterpriseConfigGetCall) Fields added in v0.61.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaEnterpriseConfigGetCall) Header added in v0.61.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaEnterpriseConfigGetCall) IfNoneMatch added in v0.61.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsRecaptchaEnterpriseConfigPatchCall added in v0.61.0

type ProjectsAppsRecaptchaEnterpriseConfigPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaEnterpriseConfigPatchCall) Context added in v0.61.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaEnterpriseConfigPatchCall) Do added in v0.61.0

Do executes the "firebaseappcheck.projects.apps.recaptchaEnterpriseConfig.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaEnterpriseConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaEnterpriseConfigPatchCall) Fields added in v0.61.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaEnterpriseConfigPatchCall) Header added in v0.61.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaEnterpriseConfigPatchCall) UpdateMask added in v0.61.0

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the RecaptchaEnterpriseConfig to update. Example: `site_key`.

type ProjectsAppsRecaptchaEnterpriseConfigService added in v0.61.0

type ProjectsAppsRecaptchaEnterpriseConfigService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsRecaptchaEnterpriseConfigService added in v0.61.0

func NewProjectsAppsRecaptchaEnterpriseConfigService(s *Service) *ProjectsAppsRecaptchaEnterpriseConfigService

func (*ProjectsAppsRecaptchaEnterpriseConfigService) BatchGet added in v0.61.0

BatchGet: Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.

  • parent: The parent project name shared by all RecaptchaEnterpriseConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsRecaptchaEnterpriseConfigService) Get added in v0.61.0

Get: Gets the RecaptchaEnterpriseConfig for the specified app.

  • name: The relative resource name of the RecaptchaEnterpriseConfig, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```.

func (*ProjectsAppsRecaptchaEnterpriseConfigService) Patch added in v0.61.0

Patch: 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.

  • name: The relative resource name of the reCAPTCHA Enterprise configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```.

type ProjectsAppsRecaptchaV3ConfigBatchGetCall added in v0.74.0

type ProjectsAppsRecaptchaV3ConfigBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaV3ConfigBatchGetCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaV3ConfigBatchGetCall) Do added in v0.74.0

Do executes the "firebaseappcheck.projects.apps.recaptchaV3Config.batchGet" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetRecaptchaV3ConfigsResponse.ServerRespons e.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaV3ConfigBatchGetCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaV3ConfigBatchGetCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaV3ConfigBatchGetCall) IfNoneMatch added in v0.74.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsRecaptchaV3ConfigBatchGetCall) Names added in v0.74.0

Names sets the optional parameter "names": Required. The relative resource names of the RecaptchaV3Configs to retrieve, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsRecaptchaV3ConfigGetCall added in v0.74.0

type ProjectsAppsRecaptchaV3ConfigGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaV3ConfigGetCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaV3ConfigGetCall) Do added in v0.74.0

Do executes the "firebaseappcheck.projects.apps.recaptchaV3Config.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaV3Config.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaV3ConfigGetCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaV3ConfigGetCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaV3ConfigGetCall) IfNoneMatch added in v0.74.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsRecaptchaV3ConfigPatchCall added in v0.74.0

type ProjectsAppsRecaptchaV3ConfigPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsRecaptchaV3ConfigPatchCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsRecaptchaV3ConfigPatchCall) Do added in v0.74.0

Do executes the "firebaseappcheck.projects.apps.recaptchaV3Config.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaRecaptchaV3Config.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsRecaptchaV3ConfigPatchCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsRecaptchaV3ConfigPatchCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsRecaptchaV3ConfigPatchCall) UpdateMask added in v0.74.0

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the RecaptchaV3Config to update. Example: `site_secret`.

type ProjectsAppsRecaptchaV3ConfigService added in v0.74.0

type ProjectsAppsRecaptchaV3ConfigService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsRecaptchaV3ConfigService added in v0.74.0

func NewProjectsAppsRecaptchaV3ConfigService(s *Service) *ProjectsAppsRecaptchaV3ConfigService

func (*ProjectsAppsRecaptchaV3ConfigService) BatchGet added in v0.74.0

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

  • parent: The parent project name shared by all RecaptchaV3Configs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsRecaptchaV3ConfigService) Get added in v0.74.0

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

  • name: The relative resource name of the RecaptchaV3Config, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ```.

func (*ProjectsAppsRecaptchaV3ConfigService) Patch added in v0.74.0

Patch: 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.

  • name: The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ```.

type ProjectsAppsSafetyNetConfigBatchGetCall added in v0.51.0

type ProjectsAppsSafetyNetConfigBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsSafetyNetConfigBatchGetCall) Context added in v0.51.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsSafetyNetConfigBatchGetCall) Do added in v0.51.0

Do executes the "firebaseappcheck.projects.apps.safetyNetConfig.batchGet" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse.ServerResponse. Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsSafetyNetConfigBatchGetCall) Fields added in v0.51.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsSafetyNetConfigBatchGetCall) Header added in v0.51.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsSafetyNetConfigBatchGetCall) IfNoneMatch added in v0.51.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsAppsSafetyNetConfigBatchGetCall) Names added in v0.51.0

Names sets the optional parameter "names": Required. The relative resource names of the SafetyNetConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` A maximum of 100 objects can be retrieved in a batch.

type ProjectsAppsSafetyNetConfigGetCall added in v0.51.0

type ProjectsAppsSafetyNetConfigGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsSafetyNetConfigGetCall) Context added in v0.51.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsSafetyNetConfigGetCall) Do added in v0.51.0

Do executes the "firebaseappcheck.projects.apps.safetyNetConfig.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaSafetyNetConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsSafetyNetConfigGetCall) Fields added in v0.51.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsSafetyNetConfigGetCall) Header added in v0.51.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsSafetyNetConfigGetCall) IfNoneMatch added in v0.51.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsAppsSafetyNetConfigPatchCall added in v0.51.0

type ProjectsAppsSafetyNetConfigPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsAppsSafetyNetConfigPatchCall) Context added in v0.51.0

Context sets the context to be used in this call's Do method.

func (*ProjectsAppsSafetyNetConfigPatchCall) Do added in v0.51.0

Do executes the "firebaseappcheck.projects.apps.safetyNetConfig.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaSafetyNetConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsAppsSafetyNetConfigPatchCall) Fields added in v0.51.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsAppsSafetyNetConfigPatchCall) Header added in v0.51.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsAppsSafetyNetConfigPatchCall) UpdateMask added in v0.51.0

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the SafetyNetConfig to update. Example: `token_ttl`.

type ProjectsAppsSafetyNetConfigService added in v0.51.0

type ProjectsAppsSafetyNetConfigService struct {
	// contains filtered or unexported fields
}

func NewProjectsAppsSafetyNetConfigService added in v0.51.0

func NewProjectsAppsSafetyNetConfigService(s *Service) *ProjectsAppsSafetyNetConfigService

func (*ProjectsAppsSafetyNetConfigService) BatchGet added in v0.51.0

BatchGet: Atomically gets the SafetyNetConfigs for the specified list of apps.

  • parent: The parent project name shared by all SafetyNetConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.

func (*ProjectsAppsSafetyNetConfigService) Get added in v0.51.0

Get: Gets the SafetyNetConfig for the specified app.

  • name: The relative resource name of the SafetyNetConfig, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```.

func (*ProjectsAppsSafetyNetConfigService) Patch added in v0.51.0

Patch: 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.

  • name: The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```.

type ProjectsAppsService

type ProjectsAppsService struct {
	AppAttestConfig *ProjectsAppsAppAttestConfigService

	DebugTokens *ProjectsAppsDebugTokensService

	DeviceCheckConfig *ProjectsAppsDeviceCheckConfigService

	PlayIntegrityConfig *ProjectsAppsPlayIntegrityConfigService

	RecaptchaConfig *ProjectsAppsRecaptchaConfigService

	RecaptchaEnterpriseConfig *ProjectsAppsRecaptchaEnterpriseConfigService

	RecaptchaV3Config *ProjectsAppsRecaptchaV3ConfigService

	SafetyNetConfig *ProjectsAppsSafetyNetConfigService
	// contains filtered or unexported fields
}

func NewProjectsAppsService

func NewProjectsAppsService(s *Service) *ProjectsAppsService

func (*ProjectsAppsService) ExchangeAppAttestAssertion added in v0.49.0

func (r *ProjectsAppsService) ExchangeAppAttestAssertion(appid string, googlefirebaseappcheckv1betaexchangeappattestassertionrequest *GoogleFirebaseAppcheckV1betaExchangeAppAttestAssertionRequest) *ProjectsAppsExchangeAppAttestAssertionCall

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

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

func (*ProjectsAppsService) ExchangeAppAttestAttestation added in v0.49.0

func (r *ProjectsAppsService) ExchangeAppAttestAttestation(appid string, googlefirebaseappcheckv1betaexchangeappattestattestationrequest *GoogleFirebaseAppcheckV1betaExchangeAppAttestAttestationRequest) *ProjectsAppsExchangeAppAttestAttestationCall

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

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

func (*ProjectsAppsService) ExchangeCustomToken

func (r *ProjectsAppsService) ExchangeCustomToken(appid string, googlefirebaseappcheckv1betaexchangecustomtokenrequest *GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest) *ProjectsAppsExchangeCustomTokenCall

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

  • app: The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeDebugToken

func (r *ProjectsAppsService) ExchangeDebugToken(appid string, googlefirebaseappcheckv1betaexchangedebugtokenrequest *GoogleFirebaseAppcheckV1betaExchangeDebugTokenRequest) *ProjectsAppsExchangeDebugTokenCall

ExchangeDebugToken: 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.

  • app: The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

func (*ProjectsAppsService) ExchangeDeviceCheckToken

func (r *ProjectsAppsService) ExchangeDeviceCheckToken(appid string, googlefirebaseappcheckv1betaexchangedevicechecktokenrequest *GoogleFirebaseAppcheckV1betaExchangeDeviceCheckTokenRequest) *ProjectsAppsExchangeDeviceCheckTokenCall

ExchangeDeviceCheckToken: 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 AppCheckToken.

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangePlayIntegrityToken added in v0.78.0

func (r *ProjectsAppsService) ExchangePlayIntegrityToken(appid string, googlefirebaseappcheckv1betaexchangeplayintegritytokenrequest *GoogleFirebaseAppcheckV1betaExchangePlayIntegrityTokenRequest) *ProjectsAppsExchangePlayIntegrityTokenCall

ExchangePlayIntegrityToken: Validates an integrity verdict response token from Play Integrity (https://developer.android.com/google/play/integrity/verdict#decrypt-verify). If valid, returns an AppCheckToken.

  • app: The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeRecaptchaEnterpriseToken added in v0.61.0

func (r *ProjectsAppsService) ExchangeRecaptchaEnterpriseToken(appid string, googlefirebaseappcheckv1betaexchangerecaptchaenterprisetokenrequest *GoogleFirebaseAppcheckV1betaExchangeRecaptchaEnterpriseTokenRequest) *ProjectsAppsExchangeRecaptchaEnterpriseTokenCall

ExchangeRecaptchaEnterpriseToken: Validates a reCAPTCHA Enterprise response token (https://cloud.google.com/recaptcha-enterprise/docs/create-assessment#retrieve_token). If valid, returns an App Check token AppCheckToken.

  • app: The relative resource name of the web app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeRecaptchaToken

func (r *ProjectsAppsService) ExchangeRecaptchaToken(appid string, googlefirebaseappcheckv1betaexchangerecaptchatokenrequest *GoogleFirebaseAppcheckV1betaExchangeRecaptchaTokenRequest) *ProjectsAppsExchangeRecaptchaTokenCall

ExchangeRecaptchaToken: Validates a reCAPTCHA v3 response token (https://developers.google.com/recaptcha/docs/v3). If valid, returns an AppCheckToken.

  • app: The relative resource name of the web app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeRecaptchaV3Token added in v0.73.0

func (r *ProjectsAppsService) ExchangeRecaptchaV3Token(appid string, googlefirebaseappcheckv1betaexchangerecaptchav3tokenrequest *GoogleFirebaseAppcheckV1betaExchangeRecaptchaV3TokenRequest) *ProjectsAppsExchangeRecaptchaV3TokenCall

ExchangeRecaptchaV3Token: Validates a reCAPTCHA v3 response token (https://developers.google.com/recaptcha/docs/v3). If valid, returns an AppCheckToken.

  • app: The relative resource name of the web app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) ExchangeSafetyNetToken

func (r *ProjectsAppsService) ExchangeSafetyNetToken(appid string, googlefirebaseappcheckv1betaexchangesafetynettokenrequest *GoogleFirebaseAppcheckV1betaExchangeSafetyNetTokenRequest) *ProjectsAppsExchangeSafetyNetTokenCall

ExchangeSafetyNetToken: Validates a SafetyNet token (https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an AppCheckToken.

  • app: The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

func (*ProjectsAppsService) GenerateAppAttestChallenge added in v0.49.0

func (r *ProjectsAppsService) GenerateAppAttestChallenge(appid string, googlefirebaseappcheckv1betagenerateappattestchallengerequest *GoogleFirebaseAppcheckV1betaGenerateAppAttestChallengeRequest) *ProjectsAppsGenerateAppAttestChallengeCall

GenerateAppAttestChallenge: 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.

  • app: The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard. Alternatively, if this method is being called for an OAuth client protected by App Check, this field can also be in the format: ``` oauthClients/{oauth_client_id} ``` You can view the OAuth client ID for your OAuth clients in the Google Cloud console. Note that only iOS OAuth clients are supported at this time, and they must be linked to corresponding iOS Firebase apps. Please see the documentation (https://developers.google.com/identity/sign-in/ios/appcheck/get-started#project-setup) for more information.

func (*ProjectsAppsService) GeneratePlayIntegrityChallenge added in v0.78.0

func (r *ProjectsAppsService) GeneratePlayIntegrityChallenge(appid string, googlefirebaseappcheckv1betagenerateplayintegritychallengerequest *GoogleFirebaseAppcheckV1betaGeneratePlayIntegrityChallengeRequest) *ProjectsAppsGeneratePlayIntegrityChallengeCall

GeneratePlayIntegrityChallenge: 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.

  • app: The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

type ProjectsService

type ProjectsService struct {
	Apps *ProjectsAppsService

	Services *ProjectsServicesService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) VerifyAppCheckToken added in v0.121.0

func (r *ProjectsService) VerifyAppCheckToken(projectid string, googlefirebaseappcheckv1betaverifyappchecktokenrequest *GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenRequest) *ProjectsVerifyAppCheckTokenCall

VerifyAppCheckToken: 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` (https://firebase.google.com/docs/projects/iam/permissions#app-check) permission to call this method. This permission is part of the Firebase App Check Token Verifier role (https://firebase.google.com/docs/projects/iam/roles-predefined-product#app-check).

  • project: The relative resource name of the project for which the token was minted, in the format: ``` projects/{project_number} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 (https://google.aip.dev/cloud/2510) standard.

type ProjectsServicesBatchUpdateCall

type ProjectsServicesBatchUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesBatchUpdateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesBatchUpdateCall) Do

Do executes the "firebaseappcheck.projects.services.batchUpdate" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchUpdateServicesResponse.ServerResponse.Heade r or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesBatchUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesBatchUpdateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsServicesGetCall

type ProjectsServicesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesGetCall) Do

Do executes the "firebaseappcheck.projects.services.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaService.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesGetCall) Header

func (c *ProjectsServicesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsServicesGetCall) IfNoneMatch

func (c *ProjectsServicesGetCall) IfNoneMatch(entityTag string) *ProjectsServicesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsServicesListCall

type ProjectsServicesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesListCall) Do

Do executes the "firebaseappcheck.projects.services.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaListServicesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesListCall) Header

func (c *ProjectsServicesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsServicesListCall) IfNoneMatch

func (c *ProjectsServicesListCall) IfNoneMatch(entityTag string) *ProjectsServicesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsServicesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of Services to return in the response. Only explicitly configured services are returned. The server may return fewer than this at its own discretion. If no value is specified or set to zero (or too large a value is specified), the server will impose its own limit.

func (*ProjectsServicesListCall) PageToken

func (c *ProjectsServicesListCall) PageToken(pageToken string) *ProjectsServicesListCall

PageToken sets the optional parameter "pageToken": Token returned from a previous call to ListServices indicating where in the set of Services to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListServices must match the call that provided the page token; if they do not match, the result is undefined.

func (*ProjectsServicesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsServicesPatchCall

type ProjectsServicesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesPatchCall) Do

Do executes the "firebaseappcheck.projects.services.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaService.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsServicesPatchCall) UpdateMask

func (c *ProjectsServicesPatchCall) UpdateMask(updateMask string) *ProjectsServicesPatchCall

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`.

type ProjectsServicesResourcePoliciesBatchUpdateCall added in v0.154.0

type ProjectsServicesResourcePoliciesBatchUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesResourcePoliciesBatchUpdateCall) Context added in v0.154.0

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesResourcePoliciesBatchUpdateCall) Do added in v0.154.0

Do executes the "firebaseappcheck.projects.services.resourcePolicies.batchUpdate" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse.ServerRespon se.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesResourcePoliciesBatchUpdateCall) Fields added in v0.154.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesResourcePoliciesBatchUpdateCall) Header added in v0.154.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsServicesResourcePoliciesCreateCall added in v0.154.0

type ProjectsServicesResourcePoliciesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesResourcePoliciesCreateCall) Context added in v0.154.0

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesResourcePoliciesCreateCall) Do added in v0.154.0

Do executes the "firebaseappcheck.projects.services.resourcePolicies.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaResourcePolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesResourcePoliciesCreateCall) Fields added in v0.154.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesResourcePoliciesCreateCall) Header added in v0.154.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsServicesResourcePoliciesDeleteCall added in v0.154.0

type ProjectsServicesResourcePoliciesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesResourcePoliciesDeleteCall) Context added in v0.154.0

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesResourcePoliciesDeleteCall) Do added in v0.154.0

Do executes the "firebaseappcheck.projects.services.resourcePolicies.delete" call. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesResourcePoliciesDeleteCall) Etag added in v0.154.0

Etag sets the optional parameter "etag": The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the ResourcePolicy object, and can be obtained from the ResourcePolicy object received from the last CreateResourcePolicy, GetResourcePolicy, ListResourcePolicies, UpdateResourcePolicy, or BatchUpdateResourcePolicies call. This etag is strongly validated as defined by RFC 7232.

func (*ProjectsServicesResourcePoliciesDeleteCall) Fields added in v0.154.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesResourcePoliciesDeleteCall) Header added in v0.154.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsServicesResourcePoliciesGetCall added in v0.154.0

type ProjectsServicesResourcePoliciesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesResourcePoliciesGetCall) Context added in v0.154.0

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesResourcePoliciesGetCall) Do added in v0.154.0

Do executes the "firebaseappcheck.projects.services.resourcePolicies.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaResourcePolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesResourcePoliciesGetCall) Fields added in v0.154.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesResourcePoliciesGetCall) Header added in v0.154.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsServicesResourcePoliciesGetCall) IfNoneMatch added in v0.154.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsServicesResourcePoliciesListCall added in v0.154.0

type ProjectsServicesResourcePoliciesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesResourcePoliciesListCall) Context added in v0.154.0

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesResourcePoliciesListCall) Do added in v0.154.0

Do executes the "firebaseappcheck.projects.services.resourcePolicies.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse.ServerResponse.Head er or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesResourcePoliciesListCall) Fields added in v0.154.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesResourcePoliciesListCall) Filter added in v0.158.0

Filter sets the optional parameter "filter": Filters the results by the specified rule. For the exact syntax of this field, please consult the AIP-160 (https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/" * `enforcement_mode = ENFORCED AND target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"

func (*ProjectsServicesResourcePoliciesListCall) Header added in v0.154.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsServicesResourcePoliciesListCall) IfNoneMatch added in v0.154.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsServicesResourcePoliciesListCall) PageSize added in v0.154.0

PageSize sets the optional parameter "pageSize": The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

func (*ProjectsServicesResourcePoliciesListCall) PageToken added in v0.154.0

PageToken sets the optional parameter "pageToken": Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.

func (*ProjectsServicesResourcePoliciesListCall) Pages added in v0.154.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsServicesResourcePoliciesPatchCall added in v0.154.0

type ProjectsServicesResourcePoliciesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsServicesResourcePoliciesPatchCall) Context added in v0.154.0

Context sets the context to be used in this call's Do method.

func (*ProjectsServicesResourcePoliciesPatchCall) Do added in v0.154.0

Do executes the "firebaseappcheck.projects.services.resourcePolicies.patch" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaResourcePolicy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsServicesResourcePoliciesPatchCall) Fields added in v0.154.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsServicesResourcePoliciesPatchCall) Header added in v0.154.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsServicesResourcePoliciesPatchCall) UpdateMask added in v0.154.0

UpdateMask sets the optional parameter "updateMask": Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.

type ProjectsServicesResourcePoliciesService added in v0.154.0

type ProjectsServicesResourcePoliciesService struct {
	// contains filtered or unexported fields
}

func NewProjectsServicesResourcePoliciesService added in v0.154.0

func NewProjectsServicesResourcePoliciesService(s *Service) *ProjectsServicesResourcePoliciesService

func (*ProjectsServicesResourcePoliciesService) BatchUpdate added in v0.154.0

BatchUpdate: Atomically updates the specified ResourcePolicy configurations.

  • parent: The parent service name, in the format ``` projects/{project_number}/services/{service_id} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails.

func (*ProjectsServicesResourcePoliciesService) Create added in v0.154.0

Create: Creates the specified ResourcePolicy configuration.

  • parent: The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS).

func (*ProjectsServicesResourcePoliciesService) Delete added in v0.154.0

Delete: Deletes the specified ResourcePolicy configuration.

  • name: The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_ policy_id} ```.

func (*ProjectsServicesResourcePoliciesService) Get added in v0.154.0

Get: Gets the requested ResourcePolicy configuration.

  • name: The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_ policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS).

func (*ProjectsServicesResourcePoliciesService) List added in v0.154.0

List: Lists all ResourcePolicy configurations for the specified project and service.

  • parent: The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS).

func (*ProjectsServicesResourcePoliciesService) Patch added in v0.154.0

Patch: Updates the specified ResourcePolicy configuration.

  • name: The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_ policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.

type ProjectsServicesService

type ProjectsServicesService struct {
	ResourcePolicies *ProjectsServicesResourcePoliciesService
	// contains filtered or unexported fields
}

func NewProjectsServicesService

func NewProjectsServicesService(s *Service) *ProjectsServicesService

func (*ProjectsServicesService) BatchUpdate

func (r *ProjectsServicesService) BatchUpdate(parent string, googlefirebaseappcheckv1betabatchupdateservicesrequest *GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest) *ProjectsServicesBatchUpdateCall

BatchUpdate: Atomically updates the specified Service configurations.

  • parent: The parent project name shared by all Service configurations being updated, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails.

func (*ProjectsServicesService) Get

Get: Gets the Service configuration for the specified service name.

  • name: The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform).

func (*ProjectsServicesService) List

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

  • parent: The relative resource name of the parent project for which to list each associated Service, in the format: ``` projects/{project_number} ```.

func (*ProjectsServicesService) Patch

func (r *ProjectsServicesService) Patch(name string, googlefirebaseappcheckv1betaservice *GoogleFirebaseAppcheckV1betaService) *ProjectsServicesPatchCall

Patch: Updates the specified Service configuration.

  • name: The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform).

type ProjectsVerifyAppCheckTokenCall added in v0.121.0

type ProjectsVerifyAppCheckTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsVerifyAppCheckTokenCall) Context added in v0.121.0

Context sets the context to be used in this call's Do method.

func (*ProjectsVerifyAppCheckTokenCall) Do added in v0.121.0

Do executes the "firebaseappcheck.projects.verifyAppCheckToken" call. Any non-2xx status code is an error. Response headers are in either *GoogleFirebaseAppcheckV1betaVerifyAppCheckTokenResponse.ServerResponse.Heade r or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsVerifyAppCheckTokenCall) Fields added in v0.121.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsVerifyAppCheckTokenCall) Header added in v0.121.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Jwks *JwksService

	OauthClients *OauthClientsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL