flows_executor_get

GET 
/api/v3//flows/executor/:flow_slug/

Get the next pending challenge from the currently active flow.

Request

Path Parameters

flow_slug stringrequired

Query Parameters

query stringrequired

Querystring as received

Responses

200

application/json

Schema

Schema

component
Possible values: [ak-stage-access-denied, ak-source-oauth-apple, ak-stage-authenticator-duo, ak-stage-authenticator-email, ak-stage-authenticator-sms, ak-stage-authenticator-static, ak-stage-authenticator-totp, ak-stage-authenticator-validate, ak-stage-authenticator-webauthn, ak-stage-autosubmit, ak-stage-captcha, ak-stage-consent, ak-stage-dummy, ak-stage-email, ak-stage-flow-error, xak-flow-frame, ak-stage-identification, ak-provider-oauth2-device-code, ak-provider-oauth2-device-code-finish, ak-stage-password, ak-source-plex, ak-stage-prompt, xak-flow-redirect, ak-stage-session-end, xak-flow-shell, ak-stage-user-login]
ak-stage-access-denied
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
error_messagestring
ak-source-oauth-apple
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
client_idstringrequired
scopestringrequired
redirect_uristringrequired
statestringrequired
ak-stage-authenticator-duo
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
activation_barcodestringrequired
activation_codestringrequired
stage_uuidstringrequired
ak-stage-authenticator-email
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
emailstringnullable
email_requiredboolean
Default value: true
ak-stage-authenticator-sms
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
phone_number_requiredboolean
Default value: true
ak-stage-authenticator-static
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
codesstring[]required
ak-stage-authenticator-totp
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
config_urlstringrequired
ak-stage-authenticator-validate
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
device_challenges object[]required
Array [
device_classstringrequired
device_uidstringrequired
challenge objectrequired
property name*any
last_useddate-timenullablerequired
]
configuration_stages object[]required
Array [
pkuuidrequired
namestringrequired
verbose_namestringrequired
meta_model_namestringrequired
]
ak-stage-authenticator-webauthn
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
registration objectrequired
property name*any
ak-stage-autosubmit
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
urlstringrequired
attrs objectrequired
property name*string
titlestring
ak-stage-captcha
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
site_keystringrequired
js_urlstringrequired
interactivebooleanrequired
ak-stage-consent
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
header_textstring
permissions object[]required
Array [
namestringrequired
idstringrequired
]
additional_permissions object[]required
Array [
namestringrequired
idstringrequired
]
tokenstringrequired
ak-stage-dummy
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
namestringrequired
ak-stage-email
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
ak-stage-flow-error
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
request_idstringrequired
errorstring
tracebackstring
xak-flow-frame
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
urlstringrequired
loading_overlayboolean
Default value: false
loading_textstringrequired
ak-stage-identification
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
user_fieldsstring[]nullablerequired
password_fieldsbooleanrequired
allow_show_passwordboolean
Default value: false
application_prestring
flow_designationFlowDesignationEnum (string)required
Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]
captcha_stage objectnullable
Site public key
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
componentstring
Default value: ak-stage-captcha
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
site_keystringrequired
js_urlstringrequired
interactivebooleanrequired
enroll_urlstring
recovery_urlstring
passwordless_urlstring
primary_actionstringrequired
sources object[]
Array [
namestringrequired
icon_urlstringnullable
challenge objectrequired
component
Possible values: [xak-flow-redirect, ak-source-oauth-apple, ak-source-plex]
xak-flow-redirect
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
tostringrequired
ak-source-oauth-apple
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
client_idstringrequired
scopestringrequired
redirect_uristringrequired
statestringrequired
ak-source-plex
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
client_idstringrequired
slugstringrequired
]
show_source_labelsbooleanrequired
ak-provider-oauth2-device-code
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
ak-provider-oauth2-device-code-finish
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
ak-stage-password
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
recovery_urlstring
allow_show_passwordboolean
Default value: false
ak-source-plex
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
client_idstringrequired
slugstringrequired
ak-stage-prompt
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
fields object[]required
Array [
field_keystringrequired
labelstringrequired
typePromptTypeEnum (string)required
Possible values: [text, text_area, text_read_only, text_area_read_only, username, email, password, number, checkbox, radio-button-group, dropdown, date, date-time, file, separator, hidden, static, ak-locale]
requiredbooleanrequired
placeholderstringrequired
initial_valuestringrequired
orderintegerrequired
sub_textstringrequired
choicesstring[]nullablerequired
]
xak-flow-redirect
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
tostringrequired
ak-stage-session-end
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired
application_namestring
application_launch_urlstring
invalidation_flow_urlstring
brand_namestringrequired
xak-flow-shell
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
bodystringrequired
ak-stage-user-login
flow_info object
Contextual flow information for a challenge
titlestring
backgroundstring
cancel_urlstringrequired
layoutContextualFlowInfoLayoutEnum (string)required
Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]
response_errors object
property name* object[]
Array [
stringstringrequired
codestringrequired
]
pending_userstringrequired
pending_user_avatarstringrequired

Example (auto)

{
  "flow_info": {
    "title": "string",
    "background": "string",
    "cancel_url": "string",
    "layout": "stacked"
  },
  "component": "ak-stage-access-denied",
  "response_errors": {},
  "pending_user": "string",
  "pending_user_avatar": "string",
  "error_message": "string"
}

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.Get, "/api/v3/flows/executor/:flow_slug/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
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

flow_slug — pathrequired

query — queryrequired