oracle.oci.oci_waas_captchas – Manage a Captchas resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_waas_captchas.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to update a Captchas resource in Oracle Cloud Infrastructure

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter		Choices/Defaults	Comments
api_user string			The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string			Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string			Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string			Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_purpose string		Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type string		Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
captchas list / elements=dictionary / required			A list of CAPTCHA details.
	failure_message string / required		The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.` This parameter is updatable.
	footer_text string		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.' This parameter is updatable.
	header_text string		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.' This parameter is updatable.
	session_expiration_in_seconds integer / required		The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`. This parameter is updatable.
	submit_label string / required		The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`. This parameter is updatable.
	title string / required		The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?` This parameter is updatable.
	url string / required		The unique URL path at which to show the CAPTCHA challenge. This parameter is updatable.
cert_bundle string			The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location string			Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string			The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
realm_specific_endpoint_template_enabled boolean		Choices: no yes	Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region string			The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state string		Choices: present ←	The state of the Captchas. Use state=present to update an existing a Captchas.
tenancy string			OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
waas_policy_id string / required			The OCID of the WAAS policy. aliases: id
wait boolean		Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer			Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Update captchas
  oci_waas_captchas:
    # required
    waas_policy_id: "ocid1.waaspolicy.oc1..xxxxxxEXAMPLExxxxxx"
    captchas:
    - # required
      url: url_example
      session_expiration_in_seconds: 56
      title: title_example
      failure_message: failure_message_example
      submit_label: submit_label_example

      # optional
      header_text: header_text_example
      footer_text: footer_text_example

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
captchas complex		on success	Details of the Captchas resource acted upon by the current operation Sample: {'failure_message': 'failure_message_example', 'footer_text': 'footer_text_example', 'header_text': 'header_text_example', 'session_expiration_in_seconds': 56, 'submit_label': 'submit_label_example', 'title': 'title_example', 'url': 'url_example'}
	failure_message string	on success	The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.` Sample: failure_message_example
	footer_text string	on success	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.' Sample: footer_text_example
	header_text string	on success	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.' Sample: header_text_example
	session_expiration_in_seconds integer	on success	The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`. Sample: 56
	submit_label string	on success	The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`. Sample: submit_label_example
	title string	on success	The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?` Sample: title_example
	url string	on success	The unique URL path at which to show the CAPTCHA challenge. Sample: url_example

Authors¶

Oracle (@oracle)

oracle.oci.oci_waas_captchas – Manage a Captchas resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶