stages_captcha_partial_update
PATCH/api/v3//stages/captcha/:stage_uuid/
CaptchaStage Viewset
Request
Path Parameters
A UUID string identifying this Captcha Stage.
- application/json
Body
Possible values: non-empty
flow_set
object[]
Public key, acquired your captcha Provider.
Possible values: non-empty
Private key, acquired your captcha Provider.
Possible values: non-empty
Possible values: non-empty
Possible values: non-empty
When enabled and the received captcha score is outside of the given threshold, the stage will show an error message. When not enabled, the flow will continue, but the data from the captcha will be available in the context for policy decisions
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Get object type so that we know how to edit the object
Return object's verbose_name
Return object's plural verbose_name
Return internal model name
flow_set
object[]
Public key, acquired your captcha Provider.
When enabled and the received captcha score is outside of the given threshold, the stage will show an error message. When not enabled, the flow will continue, but the data from the captcha will be available in the context for policy decisions
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"component": "string",
"verbose_name": "string",
"verbose_name_plural": "string",
"meta_model_name": "string",
"flow_set": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"slug": "string",
"title": "string",
"background": "string",
"policy_engine_mode": "all",
"compatibility_mode": true,
"export_url": "string",
"layout": "stacked"
}
],
"public_key": "string",
"js_url": "string",
"api_url": "string",
"score_min_threshold": 0,
"score_max_threshold": 0,
"error_on_invalid_score": true
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}
Authorization: http
name: authentiktype: httpscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/stages/captcha/:stage_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n \"name\": \"string\",\n \"flow_set\": [\n {\n \"name\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"designation\": \"authentication\",\n \"policy_engine_mode\": \"all\",\n \"compatibility_mode\": true,\n \"layout\": \"stacked\",\n \"denied_action\": \"message_continue\"\n }\n ],\n \"public_key\": \"string\",\n \"private_key\": \"string\",\n \"js_url\": \"string\",\n \"api_url\": \"string\",\n \"score_min_threshold\": 0,\n \"score_max_threshold\": 0,\n \"error_on_invalid_score\": true\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());