Prepare your environment for reCAPTCHA

This document shows you how to prepare your environment to set up reCAPTCHA.

Before you begin

To get started with reCAPTCHA, do the following:

1. Sign up to create a Google Account in the Google Cloud console.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

Enable the reCAPTCHA Enterprise API

Note: To enable and get started with reCAPTCHA on Google Cloud, you don't need to enable billing for your Google Cloud project. However, we recommend enabling billing to ensure that your site remains protected after you exceed the free monthly usage limit of reCAPTCHA. For more information, see Billing information.

Console

1. In the Google Cloud console, go to the reCAPTCHA Enterprise API page.

   Go to reCAPTCHA Enterprise API

2. Verify that the name of your project appears in the project selector at the top of the page.

   If you don't see the name of your project, click the project selector, and then select your project.

3. Click Enable.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. To set your Google Cloud project in the gcloud session, run the gcloud config set project command. Replace PROJECT_ID with your Google Cloud project ID.

          gcloud config set project PROJECT_ID
          

3. To enable the reCAPTCHA Enterprise API, run the gcloud services enable command:

            gcloud services enable recaptchaenterprise.googleapis.com
          

4. To verify that the reCAPTCHA Enterprise API is enabled, run the gcloud services list command:

            gcloud services list --enabled
          

   Verify that the reCAPTCHA Enterprise API is listed in the list of enabled APIs.

Configure roles and permissions

To get the permissions that you need to set up reCAPTCHA, ask your administrator to grant you the following IAM roles on the project:

• reCAPTCHA Enterprise Admin (roles/recaptchaenterprise.admin)
• reCAPTCHA Enterprise Agent (roles/recaptchaenterprise.agent)

For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

For more information about the access control for reCAPTCHA, see Access control with IAM.

What's next

• Understand reCAPTCHA keys