Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

first

integer

Number of results to return after the cursor. Use either first/after or last/before, not both.

Required range: 1 <= x <= 100

after

string

Cursor to fetch results after. Used with 'first' for forward pagination.

last

integer

Number of results to return before the cursor. Use either first/after or last/before, not both.

Required range: 1 <= x <= 100

before

string

Cursor to fetch results before. Used with 'last' for backward pagination.

status

enum<string>

Filter requests by their status.

Request Status

Description

The RequestStatus enum is used to represent the status of a request.

Usage Example

Returned from the GET Requests endpoint.

Available options:

PENDING,

APPROVED,

DENIED,

CANCELED

string<uuid>

Filter requests assigned to a specific user ID.

from

string<uuid>

Filter requests made by a specific user ID.

Response

200 - application/json

A paginated list of requests using Relay-style cursor pagination.

edges

object[]

required

Show child attributes

edges.node

object

required

Request Object

Description

The Request object is used to represent a request.

Usage Example

Returned from the GET Requests endpoint.

Show child attributes

edges.node.id

string<uuid>

required

The unique identifier of the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

edges.node.created_at

string<date-time>

required

The date and time the request was created.

Example:

"2021-01-06T20:00:00.000Z"

edges.node.updated_at

string<date-time>

required

The date and time the request was last updated.

Example:

"2021-01-06T20:00:00.000Z"

edges.node.requester_id

string<uuid>

required

The unique identifier of the user who created the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

edges.node.status

enum<string>

required

The status of the request.

Available options:

PENDING,

APPROVED,

DENIED,

CANCELED

Example:

"pending"

edges.node.reason

string

required

The reason for the request.

Example:

"I need access to the AWS account."

edges.node.target_user_id

string<uuid>

The unique identifier of the user who is the target of the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

edges.node.target_group_id

string<uuid>

The unique identifier of the group who is the target of the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

edges.node.duration_minutes

integer

The duration of the request in minutes.

Example:

120

edges.node.requested_items_list

object[]

The list of targets for the request.

Show child attributes

edges.node.requested_items_list.resource_id

string<uuid>

The ID of the resource requested.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

edges.node.requested_items_list.group_id

string<uuid>

The ID of the group requested.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

edges.node.requested_items_list.access_level_name

string

The name of the access level requested.

Example:

"admin"

edges.node.requested_items_list.access_level_remote_id

string

The ID of the access level requested on the remote system.

Example:

"arn:aws:iam::490306337630:role/SupportUser"

edges.node.requested_items_list.name

string

The name of the target.

Example:

"Engineering Team"

edges.node.requested_items_list.remote_id

string

The ID of the target on the remote system.

Example:

"arn:aws:iam::490306337630:role/SupportUser"

edges.node.requested_items_list.remote_name

string

The name of the target on the remote system.

Example:

"SupportUser"

edges.node.custom_fields_responses

object[]

The responses given to the custom fields associated to the request

Show child attributes

edges.node.custom_fields_responses.field_name

string

required

edges.node.custom_fields_responses.field_type

enum<string>

required

The type of the custom request field.

Available options:

SHORT_TEXT,

LONG_TEXT,

BOOLEAN,

MULTI_CHOICE

Example:

"SHORT_TEXT"

edges.node.custom_fields_responses.field_value

required

Example:

"This is a response to a long text or short text or multi choice"

edges.node.stages

object

deprecated

The stages configuration for this request

Show child attributes

edges.node.stages.requestedItemName

string

required

The name of the requested item

edges.node.stages.stages

object[]

required

The stages of review for this request

Show child attributes

edges.node.stages.stages.stage

integer

required

The stage number

edges.node.stages.stages.operator

enum<string>

required

The operator to apply to reviewers in this stage

Available options:

AND,

OR

edges.node.stages.stages.reviewers

object[]

required

The reviewers for this stage

Show child attributes

edges.node.stages.stages.reviewers.id

string<uuid>

required

The unique identifier of the reviewer

edges.node.stages.stages.reviewers.status

enum<string>

required

The status of this reviewer's review

Available options:

PENDING,

APPROVED,

REJECTED

edges.node.stages.stages.reviewers.full_name

string

The user's full name.

Example:

"Jake Barnes"

edges.node.stages.requestedRoleName

string

The name of the requested role

edges.node.reviewer_stages

The configured reviewer stages for every item in this request, or an error message if reviewers could not be loaded

Show child attributes

edges.node.reviewer_stages.item_name

string

required

The name of the requested item

edges.node.reviewer_stages.item_id

string<uuid>

required

The ID of the resource requested.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

edges.node.reviewer_stages.stages

object[]

required

The stages of review for this request

Show child attributes

edges.node.reviewer_stages.stages.stage

integer

required

The stage number

edges.node.reviewer_stages.stages.operator

enum<string>

required

The operator to apply to reviewers in this stage

Available options:

AND,

OR

edges.node.reviewer_stages.stages.reviewers

object[]

required

The reviewers for this stage

Show child attributes

edges.node.reviewer_stages.stages.reviewers.id

string<uuid>

required

The unique identifier of the reviewer

edges.node.reviewer_stages.stages.reviewers.status

enum<string>

required

The status of this reviewer's review

Available options:

PENDING,

APPROVED,

REJECTED

edges.node.reviewer_stages.stages.reviewers.full_name

string

The user's full name.

Example:

"Jake Barnes"

edges.node.reviewer_stages.access_level_name

string

The name of the access level requested.

Example:

"admin"

edges.node.reviewer_stages.access_level_remote_id

string

The ID of the access level requested on the remote system.

Example:

"arn:aws:iam::490306337630:role/SupportUser"

Example:

{
  "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "created_at": "2021-01-06T20:00:00.000Z",
  "updated_at": "2021-01-06T20:00:00.000Z",
  "requester_id": "c86c85d-0651-43e2-a748-d69d658418e8",
  "target_user_id": "r86c85d-0651-43e2-a748-d69d658418e8",
  "target_group_id": "r86c85d-0651-43e2-a748-d69d658418e8",
  "status": "pending",
  "reason": "I need this resource.",
  "duration_minutes": 1440,
  "request_comments": [
    {
      "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
      "created_at": "2021-01-06T20:00:00.000Z",
      "updated_at": "2021-01-06T20:00:00.000Z",
      "request_id": "4c86c85d-0651-43e2-a748-d69d658418e8",
      "user_id": "c86c85d-0651-43e2-a748-d69d658418e8",
      "comment": "This is a comment."
    }
  ],
  "reviewer_stages": [
    {
      "requestedRoleName": "Admin",
      "requestedItemName": "AWS Production Account",
      "stages": [
        {
          "stage": 1,
          "operator": "AND",
          "reviewers": [
            {
              "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
              "status": "PENDING"
            }
          ]
        },
        {
          "stage": 2,
          "operator": "OR",
          "reviewers": [
            {
              "id": "8d86c85d-0651-43e2-a748-d69d658418e9",
              "status": "APPROVED"
            }
          ]
        }
      ]
    }
  ]
}

edges.cursor

string

required

The cursor for this request edge

pageInfo

object

required

Show child attributes

pageInfo.hasNextPage

boolean

required

Whether there are more items after the end cursor

pageInfo.endCursor

string

required

The cursor to continue pagination forwards

pageInfo.hasPreviousPage

boolean

required

Whether there are more items before the start cursor

pageInfo.startCursor

string

required

The cursor to continue pagination backwards

totalCount

integer

required

The total number of items available

API Concepts

SDKs

Opal API

Get requests via Relay

Authorizations

Query Parameters

Request Status

Description

Usage Example

Response

Request Object

Description

Usage Example