← Back to plugin index

Custom CAPTCHA
Description
Requires a user to solve a custom CAPTCHA challenge.
Intended for use with a CAPTCHA Server that is API-compatible with reCAPTCHA. For reCAPTCHA and hCAPTCHA the according plugins should be used instead.
This plugin configuration does not affect the Loginapp UI. You will need to adapt it with design kit customization.
Type name
CustomCaptcha
Class
com.airlock.iam.flow.shared.application.configuration.captcha.CustomCaptchaConfig
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 CAPTCHA account.

Attributes
String
Mandatory
Secret Key (secretKey)
Description

The secret is used to validate the CAPTCHA challenge response on the custom CAPTCHA server.

Attributes
String
Mandatory
Sensitive
CAPTCHA Service URL (captchaServiceUrl)
Description
URL of the CAPTCHA service to use. The CAPTCHA validation will be performed against a CAPTCHA server with this URL. The server API must match the reCAPTCHA API.

For example, the API request for reCAPTCHA is 'https://google.com/recaptcha/api/siteverify' as POST method with the 'secret' and the user 'response' token as POST parameters.

Attributes
String
Mandatory
Enforce CAPTCHA for step (enforceCaptchaForStep)
Description
Whether a CAPTCHA solution is always required. By default, solving a CAPTCHA in a step will cause subsequent steps with CAPTCHA to skip CAPTCHA verification. When this setting is enabled, the user is always required to solve the CAPTCHA for this step, irrespective of whether a CAPTCHA has previously been solved. Later CAPTCHA verifications are also not influenced by the step using this CAPTCHA, i.e. solving the CAPTCHA in this step has no effect on later CAPTCHA verifications. When this setting is disabled, no CAPTCHA is required if a CAPTCHA was resolved in a preceding step, unless the preceding Custom Captcha Step had this setting activated.
Attributes
Boolean
Optional
Default value
false
Type (type)
Description
The type is used to differentiate multiple types of CAPTCHA (reCAPTCHA, hCAPTCHA or multiple custom CAPTCHA). If you use multiple custom CAPTCHA make sure this type is unique.
Attributes
String
Optional
Default value
CUSTOM_CAPTCHA
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
Proxy Login Password (proxyLoginPassword)
Description
Password for the proxy if proxy authentication is used.
Attributes
String
Optional
Sensitive
YAML Template (with default values) 

type: CustomCaptcha
id: CustomCaptcha-xxxxxx
displayName: 
comment: 
properties:
  captchaServiceUrl:
  enforceCaptchaForStep: false
  proxyLoginPassword:
  proxyLoginUser:
  proxyUri:
  secretKey:
  siteKey:
  type: CUSTOM_CAPTCHA