Skip to main content

Get Flow​

Returns a flow. Flows are the links between an action and a specific point during a user interaction with ZITADEL.

Path Parameters
  • type string required

    id of the flow

Header Parameters
  • x-zitadel-orgid string

    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.

Responses

A successful response.

Schema
  • flow object
  • type object

    "the type of the flow"

  • id identifier of the type
  • name object
  • key string
  • localizedMessage string
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
  • state string

    Possible values: [FLOW_STATE_UNSPECIFIED, FLOW_STATE_INACTIVE, FLOW_STATE_ACTIVE]

    Default value: FLOW_STATE_UNSPECIFIED

    the state of the flow

  • triggerActions object[]
  • Array [
  • triggerType object
  • id identifier of the type
  • name object
  • key string
  • localizedMessage string
  • actions object[]
  • Array [
  • id string
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
  • state string

    Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]

    Default value: ACTION_STATE_UNSPECIFIED

    the state of the action

  • name string
  • script string
  • timeout string

    after which time the action will be terminated if not finished

  • allowedToFail boolean

    when true, the next action will be called even if this action fails

  • ]
  • ]
Loading...