flows_executor_get

GET 
/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

oneOf

AccessDeniedChallenge

Challenge when a flow's active stage calls stage_invalid().

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-access-denied

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

error_message string

AppleLoginChallenge

Special challenge for apple-native authentication flow, which happens on the client.

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-source-oauth-apple

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

client_id stringrequired

scope stringrequired

redirect_uri stringrequired

state stringrequired

AuthenticatorDuoChallenge

Duo Challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-authenticator-duo

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

activation_barcode stringrequired

activation_code stringrequired

stage_uuid stringrequired

AuthenticatorSMSChallenge

SMS Setup challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-authenticator-sms

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

phone_number_required boolean

Default value: true

AuthenticatorStaticChallenge

Static authenticator challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-authenticator-static

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

codes string[]required

AuthenticatorTOTPChallenge

TOTP Setup challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-authenticator-totp

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

config_url stringrequired

AuthenticatorValidationChallenge

Authenticator challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-authenticator-validate

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

device_challenges

object[]

required

Array [

device_class stringrequired

device_uid stringrequired

challenge

object

required

property name* any

]

configuration_stages

object[]

required

Array [

pk uuidrequired

name stringrequired

verbose_name stringrequired

meta_model_name stringrequired

]

AuthenticatorWebAuthnChallenge

WebAuthn Challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-authenticator-webauthn

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

registration

object

required

property name* any

AutosubmitChallenge

Autosubmit challenge used to send and navigate a POST request

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-autosubmit

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

url stringrequired

attrs

object

required

property name* string

title string

CaptchaChallenge

Site public key

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-captcha

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

site_key stringrequired

js_url stringrequired

ConsentChallenge

Challenge info for consent screens

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-consent

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

header_text string

permissions

object[]

required

Array [

name stringrequired

id stringrequired

]

additional_permissions

object[]

required

Array [

name stringrequired

id stringrequired

]

token stringrequired

DummyChallenge

Dummy challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-dummy

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

name stringrequired

EmailChallenge

Email challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-email

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

FlowErrorChallenge

Challenge class when an unhandled error occurs during a stage. Normal users are shown an error message, superusers are shown a full stacktrace.

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-flow-error

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

request_id stringrequired

error string

traceback string

IdentificationChallenge

Identification challenges with all UI elements

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-identification

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

user_fields string[]nullablerequired

password_fields booleanrequired

allow_show_password boolean

application_pre string

flow_designation FlowDesignationEnum (string)required

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

enroll_url string

recovery_url string

passwordless_url string

primary_action stringrequired

sources

object[]

Array [

name stringrequired

icon_url stringnullable

challenge

object

required

oneOf

RedirectChallenge

Challenge type to redirect the client

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: xak-flow-redirect

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

to stringrequired

PlexAuthenticationChallenge

Challenge shown to the user in identification stage

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-source-plex

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

client_id stringrequired

slug stringrequired

AppleLoginChallenge

Special challenge for apple-native authentication flow, which happens on the client.

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-source-oauth-apple

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

client_id stringrequired

scope stringrequired

redirect_uri stringrequired

state stringrequired

]

show_source_labels booleanrequired

OAuthDeviceCodeChallenge

OAuth Device code challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-provider-oauth2-device-code

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

OAuthDeviceCodeFinishChallenge

Final challenge after user enters their code

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-provider-oauth2-device-code-finish

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

PasswordChallenge

Password challenge UI fields

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-password

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

recovery_url string

allow_show_password boolean

PlexAuthenticationChallenge

Challenge shown to the user in identification stage

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-source-plex

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

client_id stringrequired

slug stringrequired

PromptChallenge

Initial challenge being sent, define fields

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-prompt

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

fields

object[]

required

Array [

field_key stringrequired

label stringrequired

type PromptTypeEnum (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]

required booleanrequired

placeholder stringrequired

initial_value stringrequired

order integerrequired

sub_text stringrequired

choices string[]nullablerequired

]

RedirectChallenge

Challenge type to redirect the client

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: xak-flow-redirect

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

to stringrequired

ShellChallenge

challenge type to render HTML as-is

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: xak-flow-shell

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

body stringrequired

UserLoginChallenge

Empty challenge

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

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

component string

Default value: ak-stage-user-login

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

pending_user stringrequired

pending_user_avatar stringrequired

Example (from schema)

{}

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

Loading...