stages_identification_list

GET 
/api/v3//stages/identification/

IdentificationStage Viewset

Request

Query Parameters

captcha_stage uuid
case_insensitive_matching boolean
enrollment_flow uuid
name string
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

password_stage uuid
passwordless_flow uuid
recovery_flow uuid
search string

A search term.

show_matched_user boolean
show_source_labels boolean

Responses

200

application/json

Schema

Schema

pagination objectrequired
nextnumberrequired
previousnumberrequired
countnumberrequired
currentnumberrequired
total_pagesnumberrequired
start_indexnumberrequired
end_indexnumberrequired
results object[]required
Array [
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]
]
user_fieldsUserFieldsEnum (string)[]
Fields of the user object to match against. (Hold shift to select multiple options)
Possible values: [email, username, upn]
password_stageuuidnullable
When set, shows a password field, instead of showing the password field as separate step.
captcha_stageuuidnullable
When set, adds functionality exactly like a Captcha stage, but baked into the Identification stage.
case_insensitive_matchingboolean
When enabled, user fields are matched regardless of their casing.
show_matched_userboolean
When a valid username/email has been entered, and this option is enabled, the user's username and avatar will be shown. Otherwise, the text that the user entered will be shown
enrollment_flowuuidnullable
Optional enrollment flow, which is linked at the bottom of the page.
recovery_flowuuidnullable
Optional recovery flow, which is linked at the bottom of the page.
passwordless_flowuuidnullable
Optional passwordless flow, which is linked at the bottom of the page.
sourcesuuid[]
Specify which sources should be shown.
show_source_labelsboolean
pretend_user_existsboolean
When enabled, the stage will succeed and continue even when incorrect user info is entered.
]

Example (auto)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "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",
          "designation": "authentication",
          "background": "string",
          "policy_engine_mode": "all",
          "compatibility_mode": true,
          "export_url": "string",
          "layout": "stacked",
          "denied_action": "message_continue"
        }
      ],
      "user_fields": [
        "email"
      ],
      "password_stage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "captcha_stage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "case_insensitive_matching": true,
      "show_matched_user": true,
      "enrollment_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "recovery_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "passwordless_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sources": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "show_source_labels": true,
      "pretend_user_exists": true
    }
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "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

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

captcha_stage — query

case_insensitive_matching — query

---truefalse

enrollment_flow — query

name — query

ordering — query

page — query

page_size — query

password_stage — query

passwordless_flow — query

recovery_flow — query

search — query

show_matched_user — query

---truefalse

show_source_labels — query

---truefalse