recaptchaenterprisekey_v1beta1.json

{
  "properties": {
    "apiVersion": {
      "description": "apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "properties": {
        "androidSettings": {
          "description": "Settings for keys that can be used by Android apps.",
          "properties": {
            "allowAllPackageNames": {
              "description": "If set to true, it means allowed_package_names will not be enforced.",
              "type": "boolean"
            },
            "allowedPackageNames": {
              "description": "Android package names of apps allowed to use the key. Example: 'com.companyname.appname'",
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "displayName": {
          "description": "Human-readable display name of this key. Modifiable by user.",
          "type": "string"
        },
        "iosSettings": {
          "description": "Settings for keys that can be used by iOS apps.",
          "properties": {
            "allowAllBundleIds": {
              "description": "If set to true, it means allowed_bundle_ids will not be enforced.",
              "type": "boolean"
            },
            "allowedBundleIds": {
              "description": "iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'",
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "projectRef": {
          "description": "Immutable. The Project that this resource belongs to.",
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "The project for the resource\n\nAllowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).",
              "type": "string"
            },
            "name": {
              "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
              "type": "string"
            },
            "namespace": {
              "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "resourceID": {
          "description": "Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.",
          "type": "string"
        },
        "testingOptions": {
          "description": "Immutable. Options for user acceptance testing.",
          "properties": {
            "testingChallenge": {
              "description": "Immutable. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE",
              "type": "string"
            },
            "testingScore": {
              "description": "Immutable. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.",
              "format": "double",
              "type": "number"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "wafSettings": {
          "description": "Immutable. Settings specific to keys that can be used for WAF (Web Application Firewall).",
          "properties": {
            "wafFeature": {
              "description": "Immutable. Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. Possible values: CHALLENGE_PAGE, SESSION_TOKEN, ACTION_TOKEN, EXPRESS",
              "type": "string"
            },
            "wafService": {
              "description": "Immutable. The WAF service that uses this key. Possible values: CA, FASTLY",
              "type": "string"
            }
          },
          "required": [
            "wafFeature",
            "wafService"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "webSettings": {
          "description": "Settings for keys that can be used by websites.",
          "properties": {
            "allowAllDomains": {
              "description": "If set to true, it means allowed_domains will not be enforced.",
              "type": "boolean"
            },
            "allowAmpTraffic": {
              "description": "If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.",
              "type": "boolean"
            },
            "allowedDomains": {
              "description": "Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "challengeSecurityPreference": {
              "description": "Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY",
              "type": "string"
            },
            "integrationType": {
              "description": "Immutable. Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE",
              "type": "string"
            }
          },
          "required": [
            "integrationType"
          ],
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "displayName",
        "projectRef"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "properties": {
        "conditions": {
          "description": "Conditions represent the latest available observation of the resource's current state.",
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "type": "string"
              },
              "message": {
                "description": "Human-readable message indicating details about last transition.",
                "type": "string"
              },
              "reason": {
                "description": "Unique, one-word, CamelCase reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the condition. Can be True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the condition.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "createTime": {
          "description": "The timestamp corresponding to the creation of this Key.",
          "format": "date-time",
          "type": "string"
        },
        "observedGeneration": {
          "description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
          "type": "integer"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "spec"
  ],
  "type": "object"
}