Rate this page

reCAPTCHA Authenticator

Schema URN
urn:pingidentity:scim:api:messages:2.0:RecaptchaAuthenticationRequest

reCAPTCHA is a free service provided by Google that distinguishes a legitimate end user from a bot using one or more challenges — typically, a simple question about a set of photographs. The reCAPTCHA identity authenticator can be used in conjunction with other identity authenticators to prevent unwanted activity from spammers and other malicious actors.

To use reCAPTCHA, you must register with Google’s service to receive a site key. The reCAPTCHA developer documentation provides instructions for integrating the reCAPTCHA widget into your auth UI.

Field Type Description
status string Indicates the authenticator state. Values are unavailable, ready, failure, or success.
recaptchaKey string A non-secret site key that uniquely identifies your site to the reCAPTCHA service. This is set by the Auth API and should not be modified by the auth UI.
recaptchaResponse string An opaque response string received from the reCAPTCHA service. This should be set by the auth UI after the end user solves the challenge presented by the reCAPTCHA service.

Authentication

In its initial state, the reCAPTCHA authenticator will provide the reCAPTCHA site key configured for the Data Governance Broker. The auth UI should provide this to the reCAPTCHA widget.

{
  "urn:pingidentity:scim:api:messages:2.0:RecaptchaAuthenticationRequest": {
    "recaptchaKey": "6LcX9CETAAAAAEpuPrcVuDMZGi6ux6_Of2eRyq6p",
    "status": "ready"
  }
}

When the end user solves the reCAPTCHA challenge presented by the widget, it will return a response code. The auth UI should pass this to the reCAPTCHA authenticator in the recaptchaResponse field.

{
  "urn:pingidentity:scim:api:messages:2.0:RecaptchaAuthenticationRequest": {
      "recaptchaKey": "6LcX9CETAAAAAEpuPrcVuDMZGi6ux6_Of2eRyq6p",
      "status": "ready",
      "recaptchaResponse": "03AHJ_VuuU4omjRD3TdDQlw4n1eRiOO--YiekrQBr8BJNuv9c-6IwvIqHdVBfEoAjkjW66HYVT3yI0HDverHpnPCG-qRmQKWJUuJUSzNaNGYrm-V3wgjcOKfpTNHMaTj0RTWYw-W7rK7oCvNBqcJGBPP2Kt0Qhtgr9J7FPQGRHyS0Kj2yimLvY6Ue_v0AT_ALYPBVUbaftszGafE3UhykVsTIfZDL-JnXn9OHfC44f-eDxM5xjEYmKEOK8tZY79-km2SV-S2noQxWYx5gE86dS7WVt-60IbGaUGUk2H5bES1I3Bd0ZZdwQPbcHxixOZlKfBoMBhYGLSfFKV_3JH0HwIlgRNefdwzYmLnZpwmcWU0PTuIj6CUwR57EOtzjdJqT-cNjFB1sPB52aMqZ_TmM2wvStArSPvXarIErz_weKEQKkU0jfGcv7w5kSMQMxT4ZpEcqKwAMZ3-oK9JkMDlr11AnRgzSXvME2cXVeCYHQeVdNvxOmFTWwOmCKBvM_G8I1_qg8bZD73N4KXEuUX6o0sQYR7ZypV7dpaVY2S2D4c8FvXpm3Y6RcmZWQFVXNDx6pJ1a12P3jYh_MszbvrxZRgss58YCBMvnq7NHXxBbVcbLTjMuHrxuI9N0QJJYB1rgI62mpfCNZ_-Hy_rnDW61QEBpXZ3mDPEqpICgVTWnvDHYoUeMOZFYqmyPYAxApHJXADSAnu91yoC0aLFcgeQ7dl2KLyC30t-1cKWxcnURm-sOhPKaNZKrGdRkypw8u9GYZI7kkslE2z5jzcrc_FmqK7gPub7QMudeNIHFe6rUv25-IplwFNMX71tKnwWTFQCxYUS81f5eoupZasxfn2cJ5DhgcJYQmN_ngsanXvfD-bldlxLy_xRiN_GhhxEEEbC2-5mqOEHZPAm40t-7XILm5EEh7bMWZcdJuby"
    }
}

The Broker will submit the reCAPTCHA response value to the reCAPTCHA service and set the status field to success if the reCAPTCHA service accepts it.

{
  "urn:pingidentity:scim:api:messages:2.0:RecaptchaAuthenticationRequest": {
      "recaptchaKey": "6LcX9CETAAAAAEpuPrcVuDMZGi6ux6_Of2eRyq6p",
      "status": "success",
      "recaptchaResponse": "03AHJ_VuuU4omjRD3TdDQlw4n1eRiOO--YiekrQBr8BJNuv9c-6IwvIqHdVBfEoAjkjW66HYVT3yI0HDverHpnPCG-qRmQKWJUuJUSzNaNGYrm-V3wgjcOKfpTNHMaTj0RTWYw-W7rK7oCvNBqcJGBPP2Kt0Qhtgr9J7FPQGRHyS0Kj2yimLvY6Ue_v0AT_ALYPBVUbaftszGafE3UhykVsTIfZDL-JnXn9OHfC44f-eDxM5xjEYmKEOK8tZY79-km2SV-S2noQxWYx5gE86dS7WVt-60IbGaUGUk2H5bES1I3Bd0ZZdwQPbcHxixOZlKfBoMBhYGLSfFKV_3JH0HwIlgRNefdwzYmLnZpwmcWU0PTuIj6CUwR57EOtzjdJqT-cNjFB1sPB52aMqZ_TmM2wvStArSPvXarIErz_weKEQKkU0jfGcv7w5kSMQMxT4ZpEcqKwAMZ3-oK9JkMDlr11AnRgzSXvME2cXVeCYHQeVdNvxOmFTWwOmCKBvM_G8I1_qg8bZD73N4KXEuUX6o0sQYR7ZypV7dpaVY2S2D4c8FvXpm3Y6RcmZWQFVXNDx6pJ1a12P3jYh_MszbvrxZRgss58YCBMvnq7NHXxBbVcbLTjMuHrxuI9N0QJJYB1rgI62mpfCNZ_-Hy_rnDW61QEBpXZ3mDPEqpICgVTWnvDHYoUeMOZFYqmyPYAxApHJXADSAnu91yoC0aLFcgeQ7dl2KLyC30t-1cKWxcnURm-sOhPKaNZKrGdRkypw8u9GYZI7kkslE2z5jzcrc_FmqK7gPub7QMudeNIHFe6rUv25-IplwFNMX71tKnwWTFQCxYUS81f5eoupZasxfn2cJ5DhgcJYQmN_ngsanXvfD-bldlxLy_xRiN_GhhxEEEbC2-5mqOEHZPAm40t-7XILm5EEh7bMWZcdJuby"
    }
}