Captcha

class oci.waas.models.Captcha(**kwargs)

Bases: object

The settings of the CAPTCHA challenge. If a specific URL should be accessed only by a human, a CAPTCHA challenge can be placed at the URL to protect the web application from bots.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

__init__(**kwargs)

Initializes a new Captcha object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • url (str) -- The value to assign to the url property of this Captcha.
  • session_expiration_in_seconds (int) -- The value to assign to the session_expiration_in_seconds property of this Captcha.
  • title (str) -- The value to assign to the title property of this Captcha.
  • header_text (str) -- The value to assign to the header_text property of this Captcha.
  • footer_text (str) -- The value to assign to the footer_text property of this Captcha.
  • failure_message (str) -- The value to assign to the failure_message property of this Captcha.
  • submit_label (str) -- The value to assign to the submit_label property of this Captcha.
failure_message

[Required] Gets the failure_message of this Captcha. The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to The CAPTCHA was incorrect. Try again.

Returns:The failure_message of this Captcha.
Return type:str
footer_text

Gets the footer_text of this Captcha. The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to 'Enter the letters and numbers as they are shown in the image above.'

Returns:The footer_text of this Captcha.
Return type:str
header_text

Gets the header_text of this Captcha. The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to 'We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.'

Returns:The header_text of this Captcha.
Return type:str
session_expiration_in_seconds

[Required] Gets the session_expiration_in_seconds of this Captcha. The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to 300.

Returns:The session_expiration_in_seconds of this Captcha.
Return type:int
submit_label

[Required] Gets the submit_label of this Captcha. The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to Yes, I am human.

Returns:The submit_label of this Captcha.
Return type:str
title

[Required] Gets the title of this Captcha. The title used when displaying a CAPTCHA challenge. If unspecified, defaults to Are you human?

Returns:The title of this Captcha.
Return type:str
url

[Required] Gets the url of this Captcha. The unique URL path at which to show the CAPTCHA challenge.

Returns:The url of this Captcha.
Return type:str