Skip to content
Authrim

Validate a Flow draft or package.

POST
/api/admin/flows/{id}/validate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/flows/example/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "editor": { "nodes": [ { "id": "entry", "type": "entry", "position": { "x": 0, "y": 0 } } ], "edges": [] } }'

Validates the supplied editor state or contract package. If the body is empty, validates the stored draft editor state for the path Flow.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
editor
object
nodes
required
Array<object>
object
id
required
string
type
required
string
title
string
position
object
x
number
y
number
key
additional properties
config
object
key
additional properties
data
object
key
additional properties
key
additional properties
edges
required
Array<object>
object
id
required
string
source
required
string
target
required
string
source_handle
string
target_handle
string
label
string
data
object
key
additional properties
key
additional properties
viewport
object
x
number
y
number
zoom
number
key
additional properties
key
additional properties
contract
object
schema_version
required
string
Allowed values: authrim.login_ui.contract.v1
mode
required
string
Allowed values: draft preview runtime export
runtime
required
object
flow_kind
required

Built-in Flow kind or a custom kind prefixed with custom:.

string
/^(login|registration|approve|account|custom:[a-z0-9][a-z0-9_-]{0,63})$/
flow_id
string
flow_version_id
string
ui
required
object
steps
required
Array<object>
object
key
additional properties
key
additional properties
capabilities
Array<object>
object
key
additional properties
runtime_bindings
object
key
additional properties
protocol_context
object
key
additional properties
key
additional properties
preview
object
key
additional properties
editor
object
nodes
required
Array<object>
object
id
required
string
type
required
string
title
string
position
object
x
number
y
number
key
additional properties
config
object
key
additional properties
data
object
key
additional properties
key
additional properties
edges
required
Array<object>
object
id
required
string
source
required
string
target
required
string
source_handle
string
target_handle
string
label
string
data
object
key
additional properties
key
additional properties
viewport
object
x
number
y
number
zoom
number
key
additional properties
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "editor": {
    "nodes": [
      {
        "id": "entry",
        "type": "entry",
        "position": {
          "x": 0,
          "y": 0
        }
      }
    ],
    "edges": []
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Flow validation response.

Media type application/json
object
valid
required
boolean
errors
required
Array<object>
object
level
required
string
Allowed values: error warning
code
required
string
message
required
string
path
string
node_id
string | null
edge_id
string | null
ref
object
key
additional properties
key
additional properties
warnings
required
Array<object>
object
level
required
string
Allowed values: error warning
code
required
string
message
required
string
path
string
node_id
string | null
edge_id
string | null
ref
object
key
additional properties
key
additional properties
issues
required
Array<object>
object
level
required
string
Allowed values: error warning
code
required
string
message
required
string
path
string
node_id
string | null
edge_id
string | null
ref
object
key
additional properties
key
additional properties
key
additional properties
Examples
{
  "valid": true,
  "errors": [],
  "warnings": [],
  "issues": []
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}