CAPTCHA YAML 設定リファレンス

CAPTCHA クライアント拡張機能は、 client-extension.yaml ファイルで定義できます。

使用法の詳細

この client-extnesion.yaml ファイルは CAPTCHA クライアント拡張を定義します。

liferay-recaptcha-etc-spring-boot:
    captchaName: reCAPTCHA CX
    captchaResponseParameterName: g-recaptcha-response
    customElementExternalReferenceCode: LXC:liferay-recaptcha-custom-element
    name: Liferay reCAPTCHA Etc Spring Boot
    oAuth2ApplicationExternalReferenceCode: liferay-recaptcha-etc-spring-boot-oauth-application-user-agent
    resourcePath: /validation
    type: captcha

必須の g-recaptcha-response プロパティは、ユーザーの CAPTCHA 応答で応答パラメータを定義します。 この値の名前は、CAPTCHA チャレンジを発行するプロバイダーまたはエンジンによって異なります。 このパラメータは、ユーザーの応答を受信し、プロバイダーで検証するために必要です。

resourcePath プロパティは、CAPTCHA エンジンまたはプロバイダーを使用してユーザー応答の検証を処理する REST コントローラーの場所を定義します。 外部アプリケーションとしてアクセス可能な REST コントローラーの実装 (Java Spring Boot アプリケーションなど) をポイントします。

CAPTCHA クライアント拡張機能では、Liferay のオブジェクトアクションによってトリガーされるリクエストを保護するために、OAuth2 アプリケーション プロファイルが必要です。 client-extension.yaml は、このプロファイルの追加の OAuth ユーザー エージェント クライアント拡張 を定義し、 oAuth2ApplicationExternalReferenceCode プロパティはそのクライアント拡張のキー値を参照します。

CAPTCHA クライアント拡張機能では、フロントエンドを処理するために カスタム要素クライアント拡張機能 も必要であり、通常は外部コンポーネントと統合されます。 customElementExternalReferenceCode プロパティは、そのクライアント拡張機能のキー値を参照します。

YAML プロパティ

これらのプロパティは CAPTCHA クライアント拡張に固有のものです。

関連トピック

• CAPTCHAクライアント拡張機能の使用