/workflow-engine/api/v1/workflows

get https://example.com/workflow-engine/api/v1/workflows

Get workflow objects.

Responses

Response body

object

count

integer

items

array of objects

items

object

uuid

The UUID of the returned object, unique to a workflow template and a request. [TR]

requester

object

The ID & display name of the user making the request [R]

requested_role

object

The ID and display name of the requested role. Display name stored for posterity.

request_justification

string

Justification for the request [R]

grant_type

string

Is the role granted permanently, or is the grant time restricted, or a floating window. The floating window starts upon initial connection at which time the Role Store converts the floating window to explicit time-restricted window. Can be overriden in decision phase. [R]

PERMANENT TIME_RESTRICTED FLOATING

grant_types

array of strings

List of role granting types. Is the role granted permanently, or is the grant time restricted, or a floating window. The floating window starts upon initial connection at which time the Role Store converts the floating window to explicit time-restricted window. [T]

grant_types

grant_start

date-time

Date & time after which the role is granted to the user. Can be overriden in decision phase. [R]

grant_end

date-time

Date & time after which the role is removed from the user. Can be overriden in decision phase. [R]

floating_length

integer

Time in hours how long the grant should last after initial connection. Can be overriden in decision phase. [R]

max_floating_duration

integer

Time in hours how long the grant should not exceed after initial connection. [T]

max_time_restricted_duration

integer

Maximum time in days where duration between start-date and end-date of role request must not exceeded this duration. [T]

requested_grant_type

string

Requested grant type, is the role granted permanently, or is the grant time restricted, or a floating window. The floating window starts upon initial connection at which time the Role Store converts the floating window to explicit time-restricted window. Can be overriden in decision phase. [R]

PERMANENT TIME_RESTRICTED FLOATING

requested_grant_start

date-time

Requested date & time after which the role is granted to the user. Can be overriden in decision phase. [R]

requested_grant_end

date-time

Requested date & time after which the role is removed from the user. Can be overriden in decision phase. [R]

requested_floating_length

integer

Requested time in hours for which the grant should last after initial connection. Can be overriden in decision phase. [R]

target_user

object

The ID of the user the request is made for [R]

target_roles

array of objects

A list of roles this workflow targets [TR]

target_roles

object

uuid

name

string

deleted

boolean

It indicates whether a role is present in the system or not. Create/Update workflow/request operations doesn't need to pass any value to this attribute. This field is not read during the Write operations.

workflow

uuid

The ID of the workflow the request is based on [TR]

action

string

Does the workflow GRANT or REMOVE the user from the role. Workflow engine needs to check that the requested action matches allowed actions defined in the template. [TR]

GRANT REMOVE BOTH

created

date-time

When the object was created [TR]

updated

date-time

When the object was updated [TR]

updated_by

uuid

ID of the user who updated the object [TR]

author

uuid

ID of the user who originally authored the object [TR]

name

string

required

length between 4 and 4096

Name of the workflow [T]

status

string

Defaults to WAITING

Computed status for the instance of the workflow - based on step statuses [R]

WAITING APPROVED DENIED

comment

string

A comment describing the object [TR]

approver_can_revoke

boolean

Defaults to false

A flag used to determine if approvers can revoke a role from target user [R]

target_role_revoked

boolean

Defaults to false

Is set to true only when the target role has been revoked via the request by one of the approvers [R]

target_role_revoked_by

object

User object of who revoked the target role [R]

target_role_revocation_time

date-time

Date and time of revocation [R]

can_bypass_revoke_workflow

boolean

Defaults to false

A flag used to determine if approvers can bypass the revoke workflow to revoke a role [T]

steps

array of objects

required

Array of steps [TR]

steps*

object

name

string

required

Workflow-step name

match

string

required

All approvers must approve or any approver can approve

ALL ANY

approvers

array of objects

required

Who are the approvers in this step

approvers*

object

role

object

required

Approving role's ID and display name

decision

string

required

Approver's decision

WAITING APPROVED DENIED

user

object

User who made the decision for the step

decision_time

date-time

When the decision was made [R]

comment

string

A comment accompanying the decision

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.com/workflow-engine/api/v1/workflows?limit=50&offset=0' \
3
     --header 'Authorization: Bearer a-proper-token-goes-here' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response, returns an array of workflows, returns an empty array if no workflows defined

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error