Skip to content
Authrim

Read current Flow Engine state.

GET
/api/flow/state/{sessionId}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/flow/state/example

Returns the current public Flow Engine state and UI contract for an existing session.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
sessionId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current Flow Engine state and UI contract.

Media type application/json
object
state
required
object
currentNodeId
required
string
visitedNodeIds
required
Array<string>
completedCapabilities
required
Array<string>
uiContract
required

Server-driven Flow Engine UI contract for the current node.

object
version
string
sessionId
string
nodeId
string
capabilities
Array<object>
object
key
additional properties
key
additional properties
Example 
{
  "state": {
    "currentNodeId": "email-code",
    "visitedNodeIds": [
      "start",
      "email-code"
    ],
    "completedCapabilities": [
      "identifier"
    ]
  }
}

400

Section titled “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

Section titled “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

Section titled “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
  }
}