Choosing the setup method for reCAPTCHA Enterprise

The way you set up reCAPTCHA Enterprise depends on your environment and the features you need in your environment. This document helps you choose the best method for setting up reCAPTCHA Enterprise considering the various aspects of your environment.

Before you begin

To get started with reCAPTCHA Enterprise, do the following:

Choosing the appropriate method to set up reCAPTCHA Enterprise

The way you set up reCAPTCHA Enterprise is based on the following factors:

  • Location of the backend: CRM or SaaS provider, third-party cloud, on-premises, or Google Cloud
  • Authentication methods: Support for external authentication methods, such as OAuth and service accounts in your environment
  • Type of deployment: New installation or migration from the previous versions

The following deployment flowchart helps you identify the best method for setting up reCAPTCHA Enterprise in your environment.


Flowchart that shows the deployment workflow

The following table helps you identify the best method for setting reCAPTCHA Enterprise based on your environment and feature requirements:

Your environment scenario reCAPTCHA Enterprise setup method
Your backend is deployed on Google Cloud. Setting up reCAPTCHA Enterprise on Google Cloud
  • Your backend is deployed on a non-Google Cloud or on-premises.
  • Your environment supports external authentication methods, such as OAuth and service accounts.

OR

  • Your backend is deployed on a CRM or SaaS provider.
  • Your environment supports external authentication methods, such as OAuth and service accounts.

OR

  • You need to use the v1 endpoint because of the following requirements:
  • Setting up reCAPTCHA Enterprise on non-Google Cloud environments
    • Your backend is deployed on a non-Google Cloud, on-premises, CRM, or SaaS provider.
    • Your environment does not support external authentication methods, such as OAuth and service accounts.
    • You are installing reCAPTCHA Enterprise for the first time.
    • OR

    • You need to use the v1beta1 endpoint because of the following requirements:
    Setting up reCAPTCHA Enterprise on non-Google Cloud environments using API Keys
    • Your backend is deployed on a non-Google Cloud, on-premises, CRM, or SaaS provider.
    • Your environment does not support external authentication methods, such as OAuth and service accounts.
    • You are migrating from a previous version of reCAPTCHA.
    Migrating from reCAPTCHA (non-Enterprise version)

    Choosing the migration method

    If you are migrating from any previous versions of reCAPTCHA, review the following options to determine the best method to complete the migration:

    Environment scenario Follow the steps in
    • Your environment supports external authentication methods, such as OAuth and service accounts.
    • OR

    • You want to use Role-Based Access Control (RBAC).
    Setting up reCAPTCHA Enterprise on non-Google Cloud environments
    Migrating from reCAPTCHA (non-Enterprise version)