Get Flow​
Returns a flow. Flows are the links between an action and a specific point during a user interaction with ZITADEL.
Path Parameters
id of the flow
Header Parameters
The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.
- 200
- default
A successful response.
Schema
- Array [
- Array [
- ]
- ]
flow object
type object
"the type of the flow"
name object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [FLOW_STATE_UNSPECIFIED
, FLOW_STATE_INACTIVE
, FLOW_STATE_ACTIVE
]
Default value: FLOW_STATE_UNSPECIFIED
the state of the flow
triggerActions object[]
triggerType object
name object
actions object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
after which time the action will be terminated if not finished
when true, the next action will be called even if this action fails
{
"flow": {
"type": {
"id": "string",
"name": {
"key": "string",
"localizedMessage": "string"
}
},
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.879Z",
"changeDate": "2024-06-13T06:44:37.879Z",
"resourceOwner": "69629023906488334"
},
"state": "FLOW_STATE_UNSPECIFIED",
"triggerActions": [
{
"triggerType": {
"id": "string",
"name": {
"key": "string",
"localizedMessage": "string"
}
},
"actions": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.879Z",
"changeDate": "2024-06-13T06:44:37.879Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
]
}
]
}
}
Schema
- Array [
- Array [
- ]
- ]
flow object
type object
"the type of the flow"
name object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [FLOW_STATE_UNSPECIFIED
, FLOW_STATE_INACTIVE
, FLOW_STATE_ACTIVE
]
Default value: FLOW_STATE_UNSPECIFIED
the state of the flow
triggerActions object[]
triggerType object
name object
actions object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
after which time the action will be terminated if not finished
when true, the next action will be called even if this action fails
{
"flow": {
"type": {
"id": "string",
"name": {
"key": "string",
"localizedMessage": "string"
}
},
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.879Z",
"changeDate": "2024-06-13T06:44:37.879Z",
"resourceOwner": "69629023906488334"
},
"state": "FLOW_STATE_UNSPECIFIED",
"triggerActions": [
{
"triggerType": {
"id": "string",
"name": {
"key": "string",
"localizedMessage": "string"
}
},
"actions": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.880Z",
"changeDate": "2024-06-13T06:44:37.880Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
]
}
]
}
}
Schema
- Array [
- Array [
- ]
- ]
flow object
type object
"the type of the flow"
name object
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [FLOW_STATE_UNSPECIFIED
, FLOW_STATE_INACTIVE
, FLOW_STATE_ACTIVE
]
Default value: FLOW_STATE_UNSPECIFIED
the state of the flow
triggerActions object[]
triggerType object
name object
actions object[]
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
after which time the action will be terminated if not finished
when true, the next action will be called even if this action fails
{
"flow": {
"type": {
"id": "string",
"name": {
"key": "string",
"localizedMessage": "string"
}
},
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.880Z",
"changeDate": "2024-06-13T06:44:37.880Z",
"resourceOwner": "69629023906488334"
},
"state": "FLOW_STATE_UNSPECIFIED",
"triggerActions": [
{
"triggerType": {
"id": "string",
"name": {
"key": "string",
"localizedMessage": "string"
}
},
"actions": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-06-13T06:44:37.880Z",
"changeDate": "2024-06-13T06:44:37.880Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
]
}
]
}
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}