Skip to main content
PATCH
Update a CAPTCHA attack protection policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the CAPTCHA attack protection policy.

Pattern: ^pol_[1-9A-HJ-NP-Za-km-z]{22}$

Body

application/json

The fields of the CAPTCHA attack protection policy to update.

Request body for updating a CAPTCHA attack protection policy. All fields are optional, but at least one must be provided. A provided match or action replaces the stored value in full rather than merging with it.

name
string

Human-readable policy name.

Required string length: 1 - 255
description
string

Description of the policy's purpose.

priority
integer

Conflict resolution order. Lower number takes higher precedence. Must be unique per tenant.

Required range: x >= 1
match
object

Traffic matching criteria for the policy. Exactly one of auth0_managed or geo_country_codes must be specified.

action
object

CAPTCHA configuration override for this policy.

Response

The CAPTCHA attack protection policy was successfully updated.

An attack protection policy override for CAPTCHA.

id
string
required

System-generated identifier for the policy.

name
string
required

Human-readable policy name.

Required string length: 1 - 255
priority
integer
required

Conflict resolution order. Lower number takes higher precedence.

Required range: x >= 1
match
object
required

Traffic matching criteria for the policy. Exactly one of auth0_managed or geo_country_codes must be specified.

action
object
required

CAPTCHA configuration override stored for this policy.

created_at
string<date-time>
required

ISO 8601 timestamp when the policy was created.

updated_at
string<date-time>
required

ISO 8601 timestamp when the policy was last updated.

description
string

Description of the policy's purpose.