/workflow-engine/api/v1/requests

post https://example.com/workflow-engine/api/v1/requests

Add a workflow to the request queue.

Query Params

offset

integer

Defaults to 0

Offset where to start fetching the items

limit

integer

≤ 100

Defaults to 50

Number of items to return

Body Params

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]

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]

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

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]

name

string

required

length between 4 and 4096

Name of the workflow [T]

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*

Headers

Authorization

string

required

Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
12
1
curl --request POST \
2
     --url 'https://example.com/workflow-engine/api/v1/requests?offset=0&limit=50' \
3
     --header 'Authorization: Bearer a-proper-token-goes-here' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "approver_can_revoke": false,
9
  "target_role_revoked": false,
10
  "can_bypass_revoke_workflow": false
11
}
12
'

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

application/json

201Workflow successfully added to the request queue

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error