--- id: flows-executor-get title: "flows_executor_get" description: "Get the next pending challenge from the currently active flow." sidebar_label: "flows_executor_get" hide_title: true hide_table_of_contents: true api: eJztXd1z2zYS/1c4erl2RrIyaR9u8nSZxO15Jh9u7d499DIsREISYopkAdCx6tH/frsLUgS/RFJ2nEbBg8ciCQKL/fjtAlwA95Mk5ZJpkcQX4eTFZBkln5TP73iQ6UT6K64n00nIVSBFioWgyM9ce3rNvZjfaS/lcSjilResWRTxeMW9pUw29DzIpOSxjrYeC7S4hSdQ9xlUlzLJNlxzqSYvfr+fCKw0ZXoNj2J4kFPhqyhbwS0VrPmGTV7cT/Q2xYdKS2hxsptOJP8zE5ID3VpmfDfN6/oz43JbVlZcHqio2sFf8AXz0GPKkzzgQH44aTT4YTrRbIW9MHybwA0FnJNCb6lrLANGxFrcwNUHoA/fkFylSay4QkqeP3uG/4Ik1lAOf7I0jURAApl/VEjPvUV5EvP3S6o670Oy+MiDpoxe7cXxCQjwGPH+H6qQhAKyQUBQRnl/0IUv4lsWifC77/84q3T090kuYj9TXKL0rEuf3TLNJPZbCx0hQS+DgCv1mseCh3sqJiibwxRfpTwQLLIVKZEecoPPYkZUF9w03KEuTaF/Ilh7ayjIY+XBbVK9SEDBekfMXV8YSYZwO9A+CIt0A8wA/2umeaU7SMCbZCXiMZ15nSVeWb5KBYmAeuAvmAySEAtYN/M7A7hO5ILosgy6ZNNc8imRQMooMby98q64ztJSEA9TB5sWqHwULSAMEdhiB43oIgvZpobxrZM8am8Mhdfvry972AWmvRTQvoweRhw2NYa0lwO5htRlxgH4pE6KqroVAff3bz2Qsf9BZKEmxvTgv3yBtcSdljTIRCRfCcByar2TwKKpkQxOVLbYCG1hFrQdejrxFNDiMfiL2a1YAaYABF++v7r2kH6udB0TtJbIY9SSKo15E6PMRkBzabYAN+Ld8G2tqY9quC4CwEBdPlZiUfWKpRp6PIak0h2JeJkQsgfoA2PtQTEOyF1nSBgKfJdFPoQnG6EUXAzUQrxrv6KTG14R/SvT9DhA32y2nVZEgYbVAJUeU/35homoUn1RFT05jtVBxJTK/X/sZfEa9DEC9eRSAv+TAOIU5YWZCXNMSHDmvUvkBrww8lP9L2YSYoV18olqMO9twLtDyamnMmAzlfOsYt4yiyKsLLgBowt43Qfn+u9XPdZP4MrPsfoxPb0I0X6XRThQgpX3Sei1B1febxcej/gGytUVjCJMqE+sYgMNGJYq9SmRob8UPApJ2aTYMLn10TtTEeykr5JMAjhGbMEjMlrUvfwdq09V8sZ07D1ikfeaMNhDv9aqGVTKFHoFZcY08JOIK5EWW0IwTjL3gGaUKGCjkF4einS0CLUItR7T7mXOYatpkNCe3cdHGUXFxxmKUV1AbQwdiQsi9kRVu8g8DsSTNFixKYr43ctKvDpKtWNAv4qIFhzNFGFr6oV8KWLezremHl7CeCwdBXYlZ7AcMqaIlq3gutauTuw2f83Lj2k1aGk1DkEY/75++wbGYTNR7+siCSuO6WrNo1FYeQ6M6Ub1cSr4G9yujxPgcSiwwQ0YHIQZOIJLJQ649fadGZwGIBwY1BE/NzCIwQEpjgJvZqRxM0bDqVlI4ylr7PqZxn05dcKMTgkk0WMPaBhHsHc6A6XFt8jPgycxAzUcyFXYXG0mZ2HLuHwBbmQlkywOWx8HLA54RPFM2+OIbZOMBtU8zjYoUvJLNJLPR9x+xJfaupRitdYU94QcRmfF4+LSPEapV9qqhBY5G9ClXQAT3hAR50jAblfDj5L8PbEfDtVFfd4rTKPLKJMlyyJ41KVAu3L+wSd/rtpEW0Zfl1VBmXJMSoZhJcSGm9b3a/Eol4Bl4i8wZdQEie5/iTNAgNg3oJuVuEI1tCPvXKv80T81H9TZbLxY/tRiMEUcr7mGCAte2tWCy7YG2zCgrRx1yc+71E/h48ywkMwpNpklOGae0eTJAPl8npkXByUnBCVNtXJIcghJytCwrTUz29g+o21NS7a+ShOU/ZQ+2lSn5UnsGZNZmA0w5fo8qMOEE8KEDqVwwPAkIUbLZ4SeYp1lrK8IvT39sl8vuvRODVKS1k8bDpJOG5JQNRwkPQkkpWsQkw9yX0C5kpZ9yUWSRJzFttToM/rDRkMHPjB26gR96Bsgw74PkA48Thw8jKI4/HgS/DCf8Ps5tqe4heRHTwHoUg2d6LRfih0JAg43Ths3SDkcajwRauwTbAaQ93mScbr04NYkvgyYhO1O13FYcdpYsdcRhxdPghfN3LbjuQdVRtwL80yNTmsqmsSEnEM0tc/ATMtP4yMUohkdWeRVCKo0b4kgz/QoYW4PtrV8wcfSPlNd/l0JLNFbcE/xCN7kobfYmqSkBnPTmzazM1AHd2h6aVckg7cw95bLRQIm11lgA1rob0BRo64yNU7XX8gbnyKptfYsdl9RT9ki4leUa9IS3n65XM0u8PoEGIyJk/2ybs3mdL7ttH3bXj2cb3sS31ZJdn6Ar/i8mdUVbckTnAdFyA/Kt3ZYc4JYU2iPw5dD+NKlRWbZwXhGWQR1KXj9s+GYBQ6lhAOz1GBIJF5f8+DM/dTMvVAGZ+tPEkvsl/60PcxXEfXS/VlWG1kqYVbyDDDqIQuQHGScHGTk+uEg40kgY81ZCCVQcB31lOvyjubr5b4SE/1bttxgYueczpBUJ0qerM/S5GsHSyLotY7liifVR7OMsj/Se+KVm6Wxh7jqsp+3zaWcDvdPDfeNKjjUP4T6w+aye5c2l0znuFS5n0PNtc7O/k7N/owqOPvrtr+d9aS+xL/kI2r1jEgeM8T52yz8d4Z9aoZtKaSz7kPe1drnoq25uk2XT8h4UFP7qRmxl0Ypweq+Bv0sH73LhjP6UzP6mso4wz/4rcXaDaa/uyUdMbhPTP4o9jJsbEdTvlSso0CzjminRNyWpijfUtCS6pJFCmu3thn0U9luOo09ciwzqK4IR3nDjUSKv4rrfF+J4pLHMomijZnAyOLKpeRBcpvv0UhLwiqZLodsBbX6dUmgMZGisU6jLtrrLFCwMgJ96i5U3RyodQqdlk0/ntrT4lxvkWmd4Ir7pVc0MHxOCFjb3qMWDayknY3feRLLdW8e49zEibiJO/ATFBYWcnYO4qCD0El/bQ/fTem43a2cUZ6IUZZ7dqQRv3MW+ZDNOnBnt/7WPttecG57Hmfqw0zdbc/zzW3P8+HoHQabYduIGWYX2n8T0OJC+y8R2teDtxF26WL9b9BKXaz/1cT6botOBwFuDPBVIMHXMwawc0mqz66BANVs2DLNenoXvX9FqkTvtRx40PIdqtbAlzxbAU0BVOoWTFgaY3g+MyukZzUFOurwBYeYp4OYh9TEQWc3dFpwc+AMkh4Oz5Z0ekg/V0aeVeIM9Jsw0EJ9nJ0eY6fNk3vKZJ+WNJLjTvNxlng6llhTDWd1hwYWj7ibR0+e0pHZX7WePfyoLTdj6RDFzVie7oylQX86R66fs+POrnM2fUI2beuJM+pDRj04QXxYT5mnBG1FaQ57NObVtC6827mlB825tT4xN0qlpvX9U/rnM8lZ8Rt+hn4SR1v7YeUuOvh8L0SzRLCcGcTJSDo5AI1jzYObRXKHM6MsFMnMpDzP0DJT5AV0K4S4AX/iDKn5N9OCal6KiKTAUyYpJ2I6WYsQQop8RlUEE4K1KAlYxA8Zl+EmzqIWmeUHTjXAwC5iAV8nUdgR+AkDjf4ti7J2/AFGVN4VYJErToutVLbo3lkhWCdiWKZ5+U4t37sxS2xqnFpqU+9BoTQF3VUOWPVZ1OfctoyDtru8zFGjMZc84DxTl8vi/JPLZfl75rLs2a7wcN5+Bg07BdhZ5alZpVEPZ5KHTJLOu+6tr/dU7DJUx3AMwqCVGLAOuHlWtjPCEzHCNn1wlvgEU7wPmohtO3De/ubTyALZ1fmNhP747BkSlus0/rRWBs8/KrOyVcGIbDNgG9Zy83iPeNaQUZzEJp2jqVS9pz0dEmPXxtYlO0rSDGWd/PjhEfnxM49BpwPv5eVFB0NCo1XHK21egaUYeaMHurmjQw3WCVQwWXEa5jC9hos54rGa8zseZDBynt8TquOM4W5OQ2p5i0cw4CpgAtLJnKVifvvDnFYiKHhLCr29Qu6Y7hVZifZuFmutcRBPPKQBNGcSh7g0QM79R96V8nU6N0GZDjx/9vzHs3+ePW+w+y27wZnGWiqkEps0ov1oUKrMjA7zzaom6ByTf62SfUtngqATRM4B+0hnzTqKtxfXk3wrZeqCejGfr4ReZ4szwNm5VcW8/LWIksUcmornby5enb+7OqduponSGxZblRPfvYLvnhFKpXOWToKEzSg1Bsj3cpiwc0NhhGxGsZmE6FlHW49OaOXkbs8me5eELmMOQ3aD97lrNKpgsrgQZAui4OeLvTrABarcGjqCZe/vF0zx32S02+HtPzNczY9aEgqFUwxh/unpQJ+++zVX6u+9X/B1o+4Q8YMfCDgQH3bRTRNaeZugJmZuZUIaecvAo9AUx7G0dDVagFZcabMgpuTT7sOu2BeTiDDPXwYBT7X1ZgNkkPq9jf58jqqHWmXPOxmzmRY/rKX5VapAOFTiGndTBAEVRJrdFYHA3e7/nLuGhw== sidebar_class_name: "get api-method" info_path: docs/developer-docs/api/reference/authentik custom_edit_url: null hide_send_button: true --- import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import Heading from "@theme/Heading"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; Get the next pending challenge from the currently active flow.

Path Parameters

Query Parameters

Schema
    oneOf
    Challenge when a flow's active stage calls `stage_invalid()`.
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Special challenge for apple-native authentication flow, which happens on the client.
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Duo Challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • SMS Setup challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Static authenticator challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • TOTP Setup challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Authenticator challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • device_challenges object[] required
  • Array [
  • challenge object required
  • ]
  • configuration_stages object[] required
  • Array [
  • ]
  • WebAuthn Challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • registration object required
    Autosubmit challenge used to send and navigate a POST request
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • attrs object required
    Site public key
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Challenge info for consent screens
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • permissions object[] required
  • Array [
  • ]
  • additional_permissions object[] required
  • Array [
  • ]
  • Dummy challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Email challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • 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
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Identification challenges with all UI elements
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • sources object[]
  • Array [
  • challenge object required
    oneOf
    Challenge type to redirect the client
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Challenge shown to the user in identification stage
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Special challenge for apple-native authentication flow, which happens on the client.
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • ]
  • OAuth Device code challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Final challenge after user enters their code
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Password challenge UI fields
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Challenge shown to the user in identification stage
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Initial challenge being sent, define fields
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • fields object[] required
  • Array [
  • ]
  • Challenge type to redirect the client
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • challenge type to render HTML as-is
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
  • Empty challenge
    flow_info object
    Contextual flow information for a challenge
    response_errors object
    property name* object[]
  • Array [
  • ]
Schema
Schema