API
Scenarios
Processes
Authorizations
Header parameters
As-ActorstringRequired
Body
scenariostringRequired
actionobjectOptional
Responses
201
Created
post
POST /processes HTTP/1.1
Host:
Authorization: Bearer jwt
As-Actor: text
Content-Type: application/json
Accept: */*
Content-Length: 134
{
"scenario": "text",
"actors": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "text",
"title": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"action": {}
}
201
Created
No content
Authorizations
Path parameters
idstring · uuidRequired
Process ID
actionstringRequired
Process action
Header parameters
As-ActorstringOptional
Specify actor when multiple actors could have performed the action and actor cannot be determined based on the user
Body
stringOptional
Responses
204
No Content
post
POST /processes/{id}/{action} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"
204
No Content
No content
API keys
Authorizations
Responses
200
Success
application/json
get
GET /apikey HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
200
Success
[
{
"id": "text",
"token": "text",
"name": "text",
"description": {},
"issued": "2025-07-15T13:51:48.658Z",
"expirationDays": 1,
"expiration": "2025-07-15T13:51:48.658Z",
"lastUsed": "2025-07-15T13:51:48.658Z",
"revoked": "2025-07-15T13:51:48.658Z",
"privileges": "scenario:read",
"processes": [
{
"scenario": "123e4567-e89b-12d3-a456-426614174000",
"actors": [
"text"
],
"actions": [
"text"
]
}
]
}
]
Authorizations
Body
namestringRequired
descriptionstringRequired
Responses
201
Created
application/json
post
POST /apikey HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 170
{
"name": "text",
"description": "text",
"privileges": [
"scenario:read"
],
"processes": [
{
"scenario": "123e4567-e89b-12d3-a456-426614174000",
"actors": [
"text"
],
"actions": [
"text"
]
}
]
}
201
Created
{
"id": "text",
"token": "text",
"name": "text",
"description": {},
"issued": "2025-07-15T13:51:48.658Z",
"expirationDays": 1,
"expiration": "2025-07-15T13:51:48.658Z",
"lastUsed": "2025-07-15T13:51:48.658Z",
"revoked": "2025-07-15T13:51:48.658Z",
"privileges": "scenario:read",
"processes": [
{
"scenario": "123e4567-e89b-12d3-a456-426614174000",
"actors": [
"text"
],
"actions": [
"text"
]
}
]
}
Last updated
Was this helpful?