Skip to main content

stages_captcha_create

POST 
/api/v3//stages/captcha/

CaptchaStage Viewset

Request​

Bodyrequired

    namestringrequired

    Possible values: non-empty

    flow_set object[]
  • Array [
    • namestringrequired

    Possible values: non-empty

    slugstringrequired

    Visible in the URL.

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    titlestringrequired

    Shown as the Title in Flow pages.

    Possible values: non-empty

    designationFlowDesignationEnum (string)required

    Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_modeboolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    layoutFlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_actionDeniedActionEnum (string)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

  • ]
    • public_keystringrequired

    Public key, acquired your captcha Provider.

    Possible values: non-empty

    private_keystringrequired

    Private key, acquired your captcha Provider.

    Possible values: non-empty

    js_urlstring

    Possible values: non-empty

    api_urlstring

    Possible values: non-empty

    interactiveboolean
    score_min_thresholddouble
    score_max_thresholddouble
    error_on_invalid_scoreboolean

    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​

Schema
    pkuuidrequired
    namestringrequired
    componentstringrequired

    Get object type so that we know how to edit the object

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    flow_set object[]
  • Array [
    • pkuuidrequired
    policybindingmodel_ptr_iduuidrequired
    namestringrequired
    slugstringrequired

    Visible in the URL.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    titlestringrequired

    Shown as the Title in Flow pages.

    designationFlowDesignationEnum (string)required

    Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    backgroundstringrequired

    Get the URL to the background image. If the name is /static or starts with http it is returned as-is

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_modeboolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    export_urlstringrequired

    Get export URL for flow

    layoutFlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_actionDeniedActionEnum (string)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

  • ]
    • public_keystringrequired

    Public key, acquired your captcha Provider.

    js_urlstring
    api_urlstring
    interactiveboolean
    score_min_thresholddouble
    score_max_thresholddouble
    error_on_invalid_scoreboolean

    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

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "/api/v3/stages/captcha/");
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  \"interactive\": true,\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());
Request Collapse all
Base URL
/api/v3
Auth
Body required
{
  "name": "string",
  "flow_set": [
    {
      "name": "string",
      "slug": "string",
      "title": "string",
      "designation": "authentication",
      "policy_engine_mode": "all",
      "compatibility_mode": true,
      "layout": "stacked",
      "denied_action": "message_continue"
    }
  ],
  "public_key": "string",
  "private_key": "string",
  "js_url": "string",
  "api_url": "string",
  "interactive": true,
  "score_min_threshold": 0,
  "score_max_threshold": 0,
  "error_on_invalid_score": true
}