API Reference
Log In
API Reference
These docs are for v22. Click to read the latest docs for v33.

/workflow-engine/api/v1/workflows/{workflow_id}

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

Update a workflow.

Path Params
string
required

Workflow ID

Body Params
requested_role
object

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

string

Justification for the request [R]

string
enum

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]

Allowed:
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
date-time

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

date-time

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

integer

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

integer

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

integer

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

string
enum

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]

Allowed:
date-time

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

date-time

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

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
uuid

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

string
enum

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]

Allowed:
string
required
length between 4 and 4096

Name of the workflow [T]

string

A comment describing the object [TR]

boolean
Defaults to false

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

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]

date-time

Date and time of revocation [R]

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*
Headers
string
required
Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses
200

Workflow successfully updated

Updated over 4 years ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 4 years ago