apm configuration captcha

apm configuration captcha(1)			  BIG-IP TMSH Manual			 apm configuration captcha(1)

NAME
       captcha - Manages CAPTCHA version 2 configuration

MODULE
       apm configuration

SYNTAX
       Configure the captcha component within the configuration module using the syntax shown in the following
       sections.

   CREATE/MODIFY
	create captcha [name]
	modify captcha [name]
	  options:
	    captcha-data-size [data-size-compact | data-size-normal]
	    captcha-data-theme [data-theme-dark | data-theme-light]
	    captcha-data-type [data-type-audio | data-type-image]
	    captcha-theme [theme-red | theme-white | theme-blackglass | theme-clean | theme-custom]
	    challenge-url [string]
	    description [string]
	    exposition-threshold [integer]
	    noscript-url [string]
	    private-key [hexadecimal string]
	    proceed-on-verification-error [false | true]
	    public-key [hexadecimal string]
	    secret [hexadecimal string]
	    site-key [hexadecimal string]
	    track-by-ip [false | true]
	    track-by-username [false | true]
	    verification-url [string]

	edit captcha [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list captcha
	list captcha [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    app-service
	    non-default-properties
	    one-line
	    partition

   DELETE
	delete captcha [name]

DESCRIPTION
       You can use the captcha component to create and manage CAPTCHA configuration.

EXAMPLES
       create captcha mycaptcha {secret 123456789abcdef site-key fedcba987654321 }
	    Creates a CAPTCHA version 2 configuration named mycaptcha that uses site secret 123456789abcdef and site
	    key fedcba987654321.

       delete captcha mycaptcha
	    Deletes the CAPTCHA version 2 configuration named mycaptcha from the system.

OPTIONS
       captcha-data-size
	    Specifies the size of the reCAPTCHA widget. The default is data-size-normal.

       captcha-data-theme
	    Specifies the color theme of the reCAPTCHA widget. The default is data-theme-light.

       captcha-data-type
	    Specifies the type of CAPTCHA to server. The default is data-type-image.

       captcha-theme
	    This option is specific to reCAPTCHA v1 and is deprecated in version 13.0.0.

       challenge-url
	    Specifies the URL of the service that provides the CAPTCHA challenge. The default is
	    www.google.com/recaptcha/api.js.

       description
	    Specifies a unique description for the CAPTCHA configuration.

       exposition-threshold
	    Specifies the number of logon attempts to allow before issuing a CAPTCHA challenge. The default is 0.

       noscript-url
	    Specifies the URL to use for obtaining the challenge if JavaScript is disabled. The default is
	    www.google.com/recaptcha/api/fallback.

       private-key
	    This option is specific to reCAPTCHA v1 and is deprecated in version 13.0.0.

       proceed-on-verification-error
	    Specifies whether to allow user access when CAPTCHA verification cannot be completed for some reason. The
	    default is true.

       public-key
	    This option is specific to reCAPTCHA v1 and is deprecated in version 13.0.0.

       secret
	    Specifies the secret provided by the CAPTCHA service provider. This option is required.

       site-key
	    Specifies the site key provided by the CAPTCHA service provider. This option is required.

       track-by-ip
	    Specifies whether to track logon failures using IP address. The default is true.

       track-by-username
	    Specifies whether to track logon failures using username. The default is true.

       verification-url
	    Specifies the URL of the service that verifies the response to the CAPTCHA challenge. The default is
	    www.google.com/recaptcha/api/siteverify.

SEE ALSO
COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or
       mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
       other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2011-2016. All rights reserved.

BIG-IP						      2016-11-01			 apm configuration captcha(1)