Partial Update for CAPTCHA Configuration

Update existing CAPTCHA configuration for your client.

PATCH https://{tenantDomain}/api/v2/attack-protection/captcha

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.AttackProtection;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.AttackProtection.Captcha.UpdateAsync(
            new UpdateAttackProtectionCaptchaRequestContent()
        );
    }

}

200

{
  "active_provider_id": "<string>",
  "arkose": {
    "site_key": "<string>",
    "fail_open": true,
    "client_subdomain": "<string>",
    "verify_subdomain": "<string>"
  },
  "auth_challenge": {
    "fail_open": true
  },
  "hcaptcha": {
    "site_key": "<string>"
  },
  "friendly_captcha": {
    "site_key": "<string>"
  },
  "recaptcha_enterprise": {
    "site_key": "<string>",
    "project_id": "<string>"
  },
  "recaptcha_v2": {
    "site_key": "<string>"
  },
  "simple_captcha": {}
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

active_provider_id · enum<string>

The id of the active provider for the CAPTCHA.

利用可能なオプション: arkose, auth_challenge, friendly_captcha, hcaptcha, recaptcha_v2, recaptcha_enterprise, simple_captcha

Maximum string length: 36

arkose · object

Show child attributes

auth_challenge · object

Show child attributes

hcaptcha · object

Show child attributes

friendly_captcha · object

Show child attributes

recaptcha_enterprise · object

Show child attributes

recaptcha_v2 · object

Show child attributes

simple_captcha · object

レスポンス

200

application/json

Captcha configuration successfully retrieved.

active_provider_id · string

arkose · object

Show child attributes

auth_challenge · object

Show child attributes

hcaptcha · object

Show child attributes

friendly_captcha · object

Show child attributes

recaptcha_enterprise · object

Show child attributes

recaptcha_v2 · object

Show child attributes

simple_captcha · object