flows_executor_solve
POST/api/v3//flows/executor/:flow_slug/
Solve the previously retrieved challenge and advanced to the next stage.
Request
Path Parameters
Query Parameters
Querystring as received
- application/json
Body
- AppleChallengeResponseRequest
- AuthenticatorDuoChallengeResponseRequest
- AuthenticatorSMSChallengeResponseRequest
- AuthenticatorStaticChallengeResponseRequest
- AuthenticatorTOTPChallengeResponseRequest
- AuthenticatorValidationChallengeResponseRequest
- AuthenticatorWebAuthnChallengeResponseRequest
- AutoSubmitChallengeResponseRequest
- CaptchaChallengeResponseRequest
- ConsentChallengeResponseRequest
- DummyChallengeResponseRequest
- EmailChallengeResponseRequest
- FrameChallengeResponseRequest
- IdentificationChallengeResponseRequest
- OAuthDeviceCodeChallengeResponseRequest
- OAuthDeviceCodeFinishChallengeResponseRequest
- PasswordChallengeResponseRequest
- PlexAuthenticationChallengeResponseRequest
- PromptChallengeResponseRequest
- UserLoginChallengeResponseRequest
oneOf
Pseudo class for apple response
Possible values: non-empty
ak-source-oauth-applePseudo class for duo response
Possible values: non-empty
ak-stage-authenticator-duoSMS Challenge response, device is set by get_response_instance
Possible values: non-empty
ak-stage-authenticator-smsPossible values: non-empty
Pseudo class for static response
Possible values: non-empty
ak-stage-authenticator-staticTOTP Challenge response, device is set by get_response_instance
Possible values: non-empty
ak-stage-authenticator-totpChallenge used for Code-based and WebAuthn authenticators
Possible values: non-empty
ak-stage-authenticator-validateselected_challenge
object
Possible values: non-empty
Possible values: non-empty
webauthn
object
WebAuthn Challenge response
Possible values: non-empty
ak-stage-authenticator-webauthnresponse
object
required
Pseudo class for autosubmit response
Possible values: non-empty
ak-stage-autosubmitValidate captcha token
Possible values: non-empty
ak-stage-captchaPossible values: non-empty
Consent challenge response, any valid response request is valid
Possible values: non-empty
ak-stage-consentPossible values: non-empty
Dummy challenge response
Possible values: non-empty
ak-stage-dummyEmail challenge resposen. No fields. This challenge is always declared invalid to give the user a chance to retry
Possible values: non-empty
ak-stage-emailBase class for all challenge responses
Possible values: non-empty
xak-flow-frameIdentification challenge
Possible values: non-empty
ak-stage-identificationPossible values: non-empty
Response that includes the user-entered device code
Possible values: non-empty
ak-provider-oauth2-device-codePossible values: non-empty
Response that device has been authenticated and tab can be closed
Possible values: non-empty
ak-provider-oauth2-device-code-finishPassword challenge response
Possible values: non-empty
ak-stage-passwordPossible values: non-empty
Pseudo class for plex response
Possible values: non-empty
ak-source-plexValidate response, fields are dynamically created based on the stage
Possible values: non-empty
ak-stage-promptUser login challenge
Possible values: non-empty
ak-stage-user-loginResponses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
- AccessDeniedChallenge
- AppleLoginChallenge
- AuthenticatorDuoChallenge
- AuthenticatorSMSChallenge
- AuthenticatorStaticChallenge
- AuthenticatorTOTPChallenge
- AuthenticatorValidationChallenge
- AuthenticatorWebAuthnChallenge
- AutosubmitChallenge
- CaptchaChallenge
- ConsentChallenge
- DummyChallenge
- EmailChallenge
- FlowErrorChallenge
- FrameChallenge
- IdentificationChallenge
- OAuthDeviceCodeChallenge
- OAuthDeviceCodeFinishChallenge
- PasswordChallenge
- PlexAuthenticationChallenge
- PromptChallenge
- RedirectChallenge
- SessionEndChallenge
- ShellChallenge
- UserLoginChallenge
oneOf
Challenge when a flow's active stage calls stage_invalid().
flow_info
object
ak-stage-access-deniedresponse_errors
object
Special challenge for apple-native authentication flow, which happens on the client.
flow_info
object
ak-source-oauth-appleresponse_errors
object
Duo Challenge
flow_info
object
ak-stage-authenticator-duoresponse_errors
object
SMS Setup challenge
flow_info
object
ak-stage-authenticator-smsresponse_errors
object
trueStatic authenticator challenge
flow_info
object
ak-stage-authenticator-staticresponse_errors
object
TOTP Setup challenge
flow_info
object
ak-stage-authenticator-totpresponse_errors
object
Authenticator challenge
flow_info
object
ak-stage-authenticator-validateresponse_errors
object
device_challenges
object[]
required
configuration_stages
object[]
required
WebAuthn Challenge
flow_info
object
ak-stage-authenticator-webauthnresponse_errors
object
registration
object
required
Autosubmit challenge used to send and navigate a POST request
flow_info
object
ak-stage-autosubmitresponse_errors
object
attrs
object
required
Site public key
flow_info
object
ak-stage-captcharesponse_errors
object
Challenge info for consent screens
flow_info
object
ak-stage-consentresponse_errors
object
permissions
object[]
required
additional_permissions
object[]
required
Dummy challenge
flow_info
object
ak-stage-dummyresponse_errors
object
Email challenge
flow_info
object
ak-stage-emailresponse_errors
object
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
ak-stage-flow-errorresponse_errors
object
Challenge type to render a frame
flow_info
object
xak-flow-frameresponse_errors
object
falseIdentification challenges with all UI elements
flow_info
object
ak-stage-identificationresponse_errors
object
falsePossible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]
captcha_stage
object
sources
object[]
OAuth Device code challenge
flow_info
object
ak-provider-oauth2-device-coderesponse_errors
object
Final challenge after user enters their code
flow_info
object
ak-provider-oauth2-device-code-finishresponse_errors
object
Password challenge UI fields
flow_info
object
ak-stage-passwordresponse_errors
object
falseChallenge shown to the user in identification stage
flow_info
object
ak-source-plexresponse_errors
object
Initial challenge being sent, define fields
flow_info
object
ak-stage-promptresponse_errors
object
fields
object[]
required
Challenge type to redirect the client
flow_info
object
xak-flow-redirectresponse_errors
object
Challenge for ending a session
flow_info
object
ak-stage-session-endresponse_errors
object
challenge type to render HTML as-is
flow_info
object
xak-flow-shellresponse_errors
object
Empty challenge
flow_info
object
ak-stage-user-loginresponse_errors
object
{}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"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.Post, "/api/v3/flows/executor/:flow_slug/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n \"component\": \"ak-source-oauth-apple\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());