When should I use the CAPTCHA client extension type?

• You want hCaptcha / reCAPTCHA / Turnstile / a custom challenge instead of Liferay's built-in. • Enterprise / compliance requires a specific CAPTCHA vendor.

How do I create a CAPTCHA client extension?

1. Ship three sibling extensions: a `customElement` for the challenge UI, a paired `oAuthApplicationUserAgent`, and this `captcha` extension. 2. Point `customElementExternalReferenceCode`, `oAuth2ApplicationExternalReferenceCode`, and `resourcePath` at them.

What fields are required on a CAPTCHA client extension?

captchaName (string): Display name in Instance Settings. captchaResponseParameterName (string): Request parameter that carries the user response. customElementExternalReferenceCode (string): Ref code of the paired customElement. oAuth2ApplicationExternalReferenceCode (string): Ref code of the paired oAuthApplicationUserAgent. resourcePath (string): Validation endpoint path.

CAPTCHA

Replace the built-in CAPTCHA with your own (hCaptcha, reCAPTCHA, custom).

type: captcha·Microservice·Liferay docs →

# description

Ships a full CAPTCHA implementation: a Custom Element renders the challenge, an OAuth-authenticated service validates the response. Liferay swaps in your CAPTCHA wherever the platform prompts for one.

Externalize business logic — actions, validation, workflow, notifications.

# when to use

→You want hCaptcha / reCAPTCHA / Turnstile / a custom challenge instead of Liferay's built-in.
→Enterprise / compliance requires a specific CAPTCHA vendor.

# how to use

01Ship three sibling extensions: a customElement for the challenge UI, a paired oAuthApplicationUserAgent, and this captcha extension.
02Point customElementExternalReferenceCode, oAuth2ApplicationExternalReferenceCode, and resourcePath at them.

# required fields

field	type	description
`captchaName`required	`string`	Display name in Instance Settings.
`captchaResponseParameterName`required	`string`	Request parameter that carries the user response.
`customElementExternalReferenceCode`required	`string`	Ref code of the paired customElement.
`oAuth2ApplicationExternalReferenceCode`required	`string`	Ref code of the paired oAuthApplicationUserAgent.
`resourcePath`required	`string`	Validation endpoint path.

# optional fields

field	type	description
`name`	`string`	Display name.

# example

client-extension.yaml

my-captcha:
    type: captcha
    captchaName: hCaptcha
    captchaResponseParameterName: h-captcha-response
    customElementExternalReferenceCode: my-captcha-widget
    oAuth2ApplicationExternalReferenceCode: my-captcha-oauth
    resourcePath: /captcha/verify

# related types

Usually shipped alongside CAPTCHA:

# more in microservice

cd ..scaffold this type in VS Code →