Cancel a Flow Engine session.

POST

/api/flow/cancel

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/flow/cancel \
  --header 'Content-Type: application/json' \
  --data '{ "sessionId": "flow_sess_123" }'

Cancels a server-driven Flow Engine session for the current tenant context and returns the cancellation status.

Request Body ^required

Media type application/json

object

sessionId

required

string

Example

{
  "sessionId": "flow_sess_123"
}

Responses

200

Successful JSON response.

Media type application/json

One of:

object

object

success

required

boolean

sessionId

required

string

object

object

success

required

boolean

error

required

object

code

required

string

message

required

string

details

object

key

additional properties

Example

{
  "success": true,
  "sessionId": "flow_sess_123"
}

400

Error response.

Media type application/json

object

error

string

error_description

string

message

string

webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object

unknown_credential

boolean

key

additional properties

Example ^generated

{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

401

Error response.

Media type application/json

object

error

string

error_description

string

message

string

webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object

unknown_credential

boolean

key

additional properties

Example ^generated

{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Error response.

Media type application/json

object

error

string

error_description

string

message

string

webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object

unknown_credential

boolean

key

additional properties

Example ^generated

{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}