---
title: Forms Recaptcha
description: The Recaptcha configuration API provides support for a Recaptcha V2 field in a form definition. It includes operations to read, update, and delete the environment's Recaptcha configuration.
component: pingone-api
page_id: pingone-api:platform:forms-recaptcha
canonical_url: https://developer.pingidentity.com/pingone-api/platform/forms-recaptcha.html
section_ids:
  assigning-admin-roles-and-permissions-to-this-service: Assigning admin roles and permissions to this service
  recaptcha-v2-data-model: Recaptcha V2 data model
  response-codes: Response codes
---

# Forms Recaptcha

The Recaptcha configuration API provides support for a Recaptcha V2 field in a form definition. It includes operations to read, update, and delete the environment's Recaptcha configuration.

|   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|   | Before you can define your environment's Recaptcha configuration in PingOne, you must register your site domain with Google to create a Recaptcha configuration. For more information about how to create the Google configuration for your domain, refer to [Google reCAPTCHA](https://www.google.com/recaptcha/admin/create). After you complete the configuration, Google provides the secret key and site key that you need to set your environment's PingOne Recaptcha configuration. |

## Assigning admin roles and permissions to this service

Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to [PingOne Permissions by Service](reference/roles-and-permissions-in-pingone/permissions-by-service.html) for the service-specific permissions.

You can also choose to assign admin roles based on particular service resources. Refer to [PingOne Permissions by Resource](reference/roles-and-permissions-in-pingone/permissions-by-resource.html) when assigning admin roles per service resources.

Admin assignments to roles are set by:

* [Automatic assignment for some roles](roles/predefined-roles.html#automatic-role-assignment).

* [Group Role Assignments](group-role-assignments/group-role-assignments.html).

* [User Role Assignments](users/user-role-assignments.html).

Refer to [Roles Management](roles.html) for more information.

## Recaptcha V2 data model

| Property         | Description                                                                                                                          |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `created`        | The time the configuration was created.                                                                                              |
| `environment.id` | A string that specifies the environment's unique identifier.                                                                         |
| `modified`       | The time the configuration was last updated.                                                                                         |
| `siteKey`        | A string that specifies the public site key for the Recaptcha configuration provided by Google. This is a required property.         |
| `secretKey`      | A string that specifies the confidential secret key for the Recaptcha configuration provided by Google. This is a required property. |

## Response codes

| Code | Message                                                               |
| ---- | --------------------------------------------------------------------- |
| 200  | Successful operation.                                                 |
| 204  | No content.                                                           |
| 400  | The request could not be completed.                                   |
| 401  | You do not have access to this resource.                              |
| 403  | You do not have permissions or are not licensed to make this request. |