Skip to content
Authrim

Import a Flow JSON package.

POST
/api/admin/flows/import
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/flows/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "schema_version": "authrim.login_ui.contract.v1", "mode": "draft", "runtime": { "flow_kind": "login", "flow_id": "example", "flow_version_id": "example", "ui": { "steps": [ { "additionalProperty": "example" } ] }, "capabilities": [ { "additionalProperty": "example" } ], "runtime_bindings": { "additionalProperty": "example" }, "protocol_context": { "additionalProperty": "example" } }, "preview": { "additionalProperty": "example" }, "editor": { "nodes": [ { "id": "example", "type": "example", "title": "example", "position": { "x": 1, "y": 1 }, "config": { "additionalProperty": "example" }, "data": { "additionalProperty": "example" } } ], "edges": [ { "id": "example", "source": "example", "target": "example", "source_handle": "example", "target_handle": "example", "label": "example", "data": { "additionalProperty": "example" } } ], "viewport": { "x": 1, "y": 1, "zoom": 1 } } }'

Imports a Flow contract package as a draft after stripping runtime-only fields and validating the package shape. Imported Flows require explicit publish before runtime use.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
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

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Flow import response.

Media type application/json
object
flow_id
required
string
validation
required
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
key
additional properties
Example 
{
  "validation": {
    "errors": [
      {
        "level": "error"
      }
    ],
    "warnings": [
      {
        "level": "error"
      }
    ],
    "issues": [
      {
        "level": "error"
      }
    ]
  }
}

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"
}