flows_instances_partial_update

PATCH 
/api/v3//flows/instances/:slug/

Flow Viewset

Request

Path Parameters

slug stringrequired

application/json

Body

namestring

Possible values: non-empty

slugstring

Visible in the URL.

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

titlestring

Shown as the Title in Flow pages.

Possible values: non-empty

designationFlowDesignationEnum (string)

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]

authenticationAuthenticationEnum (string)

Required level of authentication and authorization to access a flow.

Possible values: [none, require_authenticated, require_unauthenticated, require_superuser, require_redirect, require_outpost]

Responses

200

application/json

Schema

Schema

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

stagesuuid[]required

policiesuuid[]required

cache_countintegerrequired

Get count of cached flows

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]

authenticationAuthenticationEnum (string)

Required level of authentication and authorization to access a flow.

Possible values: [none, require_authenticated, require_unauthenticated, require_superuser, require_redirect, require_outpost]

Example (auto)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "slug": "string",
  "title": "string",
  "designation": "authentication",
  "background": "string",
  "stages": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "policies": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "cache_count": 0,
  "policy_engine_mode": "all",
  "compatibility_mode": true,
  "export_url": "string",
  "layout": "stacked",
  "denied_action": "message_continue",
  "authentication": "none"
}

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

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/flows/instances/:slug/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\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  \"authentication\": \"none\"\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

Bearer Token

Parameters

slug — pathrequired

Body

{
  "name": "string",
  "slug": "string",
  "title": "string",
  "designation": "authentication",
  "policy_engine_mode": "all",
  "compatibility_mode": true,
  "layout": "stacked",
  "denied_action": "message_continue",
  "authentication": "none"
}