stages_password_create

POST 
/api/v3//stages/password/

PasswordStage Viewset

Request

application/json

Body

required

name stringrequired

Possible values: non-empty

flow_set

object[]

Array [

name stringrequired

Possible values: non-empty

slug stringrequired

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

Visible in the URL.

title stringrequired

Possible values: non-empty

Shown as the Title in Flow pages.

designation FlowDesignationEnum (string)required

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

policy_engine_mode PolicyEngineMode (string)

Possible values: [all, any]

compatibility_mode boolean

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

layout FlowLayoutEnum (string)

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

denied_action DeniedActionEnum (string)

Possible values: [message_continue, message, continue]

]

backends BackendsEnum (string)[]required

Possible values: [authentik.core.auth.InbuiltBackend, authentik.core.auth.TokenBackend, authentik.sources.ldap.auth.LDAPBackend]

Selection of backends to test the password against.

configure_flow uuidnullable

Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.

failed_attempts_before_cancel integer

Possible values: >= -2147483648 and <= 2147483647

How many attempts a user has before the flow is canceled. To lock the user out, use a reputation policy and a user_write stage.

allow_show_password boolean

When enabled, provides a 'show password' button with the password input field.

Responses

201

application/json

Schema

Schema

pk uuidrequired
name stringrequired
component stringrequired

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

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

flow_set

object[]

Array [

pk uuidrequired

policybindingmodel_ptr_id uuidrequired

name stringrequired

slug stringrequired

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

Visible in the URL.

title stringrequired

Shown as the Title in Flow pages.

designation FlowDesignationEnum (string)required

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

background stringrequired

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

policy_engine_mode PolicyEngineMode (string)

Possible values: [all, any]

compatibility_mode boolean

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

export_url stringrequired

Get export URL for flow

layout FlowLayoutEnum (string)

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

denied_action DeniedActionEnum (string)

Possible values: [message_continue, message, continue]

]

backends BackendsEnum (string)[]required

Possible values: [authentik.core.auth.InbuiltBackend, authentik.core.auth.TokenBackend, authentik.sources.ldap.auth.LDAPBackend]

Selection of backends to test the password against.

configure_flow uuidnullable

Flow used by an authenticated user to configure this Stage. If empty, user will not be able to configure this stage.

failed_attempts_before_cancel integer

Possible values: >= -2147483648 and <= 2147483647

How many attempts a user has before the flow is canceled. To lock the user out, use a reputation policy and a user_write stage.

allow_show_password boolean

When enabled, provides a 'show password' button with the password input field.

Example (from schema)

{
  "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"
    }
  ],
  "backends": [
    "authentik.core.auth.InbuiltBackend"
  ],
  "configure_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failed_attempts_before_cancel": 0,
  "allow_show_password": true
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/stages/password/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "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"
    }
  ],
  "backends": [
    "authentik.core.auth.InbuiltBackend"
  ],
  "configure_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failed_attempts_before_cancel": 0,
  "allow_show_password": true
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

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"
    }
  ],
  "backends": [
    "authentik.core.auth.InbuiltBackend"
  ],
  "configure_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failed_attempts_before_cancel": 0,
  "allow_show_password": true
}