Create Workflow

curl --request POST \
  --url https://api.lumos.com/v1/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "steps": [
    {
      "step": "<string>",
      "inputs": {}
    }
  ],
  "description": "<string>",
  "app_id": "<string>"
}
'

import requests

url = "https://api.lumos.com/v1/workflows"

payload = {
    "name": "<string>",
    "steps": [
        {
            "step": "<string>",
            "inputs": {}
        }
    ],
    "description": "<string>",
    "app_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    steps: [{step: '<string>', inputs: {}}],
    description: '<string>',
    app_id: '<string>'
  })
};

fetch('https://api.lumos.com/v1/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/workflows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'steps' => [
        [
                'step' => '<string>',
                'inputs' => [
                                
                ]
        ]
    ],
    'description' => '<string>',
    'app_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/workflows"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step\": \"<string>\",\n      \"inputs\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"app_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lumos.com/v1/workflows")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step\": \"<string>\",\n      \"inputs\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"app_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/workflows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step\": \"<string>\",\n      \"inputs\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"app_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "type": "approval",
  "steps": [
    {
      "step": "<string>",
      "inputs": {},
      "name": "<string>"
    }
  ],
  "name": "<string>",
  "description": "<string>",
  "app_id": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Workflows

Create Workflow

Create a workflow definition.

Build the steps from GET /v1/workflow-steps?app_id={app_uuid}&type={workflow type}, which lists the steps available for an app together with the input schema each one accepts. Pass the type you are creating here; without it, only the steps every workflow type accepts are listed.

Creating a workflow does not put it to work. Bind it to an app or an entitlement through their workflow endpoints, for example PUT /v1/apps/{app_uuid}/default-provisioning-workflow. type and app_id are fixed once set.

POST

workflows

Create Workflow

curl --request POST \
  --url https://api.lumos.com/v1/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "steps": [
    {
      "step": "<string>",
      "inputs": {}
    }
  ],
  "description": "<string>",
  "app_id": "<string>"
}
'

import requests

url = "https://api.lumos.com/v1/workflows"

payload = {
    "name": "<string>",
    "steps": [
        {
            "step": "<string>",
            "inputs": {}
        }
    ],
    "description": "<string>",
    "app_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    steps: [{step: '<string>', inputs: {}}],
    description: '<string>',
    app_id: '<string>'
  })
};

fetch('https://api.lumos.com/v1/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/workflows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'steps' => [
        [
                'step' => '<string>',
                'inputs' => [
                                
                ]
        ]
    ],
    'description' => '<string>',
    'app_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/workflows"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step\": \"<string>\",\n      \"inputs\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"app_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lumos.com/v1/workflows")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step\": \"<string>\",\n      \"inputs\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"app_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/workflows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"steps\": [\n    {\n      \"step\": \"<string>\",\n      \"inputs\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"app_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "type": "approval",
  "steps": [
    {
      "step": "<string>",
      "inputs": {},
      "name": "<string>"
    }
  ],
  "name": "<string>",
  "description": "<string>",
  "app_id": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request shape for creating/updating a Workflow.

name

string

required

A name for this Workflow.

type

enum<string>

required

The kind of workflow.

Available options:

approval,

approval-chain,

entitlement-provisioning,

entitlement-deprovisioning,

account-provisioning,

account-deprovisioning

steps

WorkflowStepInput · object[]

required

The ordered steps of the workflow.

Show child attributes

description

string | null

A description of this Workflow.

app_id

string | null

UUID of the app this Workflow belongs to. May be null for a shared, not-yet-associated Workflow. Immutable on update: a PUT whose app_id differs from the Workflow's current app is rejected with a 400 (workflow.app_reassignment_not_allowed).

Response

Successful Response

Response shape for a Workflow.

string

required

A UUID identifying this Workflow.

type

enum<string>

required

The kind of workflow.

Available options:

approval,

approval-chain,

entitlement-provisioning,

entitlement-deprovisioning,

account-provisioning,

account-deprovisioning

steps

WorkflowStepOutput · object[]

required

The ordered steps of the workflow.

Show child attributes

name

string | null

A name for this Workflow.

description

string | null

A description of this Workflow.

app_id

string | null

UUID of the app this Workflow belongs to, if associated.

Quick Start

Lumos API

API Reference

Guides

Migrate from v0

Lumos Connectors

Webhooks

Tools

Create Workflow

Authorizations

Body

Response