← Back to plugin index

hCAPTCHA
Description
Requires a user to solve a hCAPTCHA challenge.
If you use an HTTPS truststore, make sure to add the root certificate for https://hcaptcha.com.
Further, you need to ensure that the correct Content Security Policy (CSP) is set. hCAPTCHA requires
  • script-src https://hcaptcha.com https://*.hcaptcha.com
  • frame-src https://hcaptcha.com https://*.hcaptcha.com
  • style-src https://hcaptcha.com https://*.hcaptcha.com
  • connect-src https://hcaptcha.com https://*.hcaptcha.com
Consult the official hCAPTCHA documentation for further information.
Type name
HCaptcha
Class
com.airlock.iam.flow.shared.application.configuration.captcha.HCaptchaConfig
May be used by
User Identification Step User Data Registration Step User Identification Step (Public Self-Service) Username Password Authentication Step Email Verification Step User Identification By Data Step (Public Self-Service) Phone Number Verification Step User Identification By Data Step
Properties
Site Key (siteKey)
Description

The site key can be assumed to be public knowledge and identifies the associated hCAPTCHA account.

The site key can be found on the hCAPTCHA profile page.

Attributes
String
Mandatory
Secret Key (secretKey)
Description

The secret key is used to validate the CAPTCHA challenge response on the hCAPTCHA server. While a leaked secret key doesn't impact the security or validity of this CAPTCHA method, its misuse can infer costs as it is used for quota calculations at the CAPTCHA provider (similar to an API key).

The secret key can be found on the hCAPTCHA profile page.

Attributes
String
Mandatory
Sensitive
Proxy URI (proxyUri)
Description
URI of a HTTP proxy the connector should use. If the port component of the URI is absent then a default port of 8080 is assumed. If this property is left empty then no proxy will be used.
Attributes
String
Optional
Example
https://proxy.company.com
Proxy Login User (proxyLoginUser)
Description
Username for the proxy if proxy authentication is used.
Attributes
String
Optional
Example
proxyLogin
Proxy Login Password (proxyLoginPassword)
Description
Password for the proxy if proxy authentication is used.
Attributes
String
Optional
Sensitive
YAML Template (with default values) 

type: HCaptcha
id: HCaptcha-xxxxxx
displayName: 
comment: 
properties:
  proxyLoginPassword:
  proxyLoginUser:
  proxyUri:
  secretKey:
  siteKey: