Get request by ID

curl --request GET \
  --url https://api.opal.dev/v1/requests/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}

GET

requests

{id}

Get request by ID

curl --request GET \
  --url https://api.opal.dev/v1/requests/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

The ID of the request.

Response

200 - application/json

The requested request object.

Request Object

Description

The Request object is used to represent a request.

Usage Example

Returned from the GET Requests endpoint.

string<uuid>

required

The unique identifier of the request.

Example:

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

created_at

string<date-time>

required

The date and time the request was created.

Example:

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

updated_at

string<date-time>

required

The date and time the request was last updated.

Example:

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

requester_id

string<uuid>

required

The unique identifier of the user who created the request.

Example:

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

status

enum<string>

required

The status of the request.

Available options:

PENDING,

APPROVED,

DENIED,

CANCELED

Example:

"pending"

reason

string

required

The reason for the request.

Example:

"I need access to the AWS account."

target_user_id

string<uuid>

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

Example:

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

target_group_id

string<uuid>

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

Example:

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

duration_minutes

integer

The duration of the request in minutes.

Example:

120

requested_items_list

object[]

The list of targets for the request.

Show child attributes

requested_items_list.resource_id

string<uuid>

The ID of the resource requested.

Example:

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

requested_items_list.group_id

string<uuid>

The ID of the group requested.

Example:

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

requested_items_list.access_level_name

string

The name of the access level requested.

Example:

"admin"

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"

requested_items_list.name

string

The name of the target.

Example:

"Engineering Team"

requested_items_list.remote_id

string

The ID of the target on the remote system.

Example:

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

requested_items_list.remote_name

string

The name of the target on the remote system.

Example:

"SupportUser"

custom_fields_responses

object[]

The responses given to the custom fields associated to the request

Show child attributes

custom_fields_responses.field_name

string

required

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"

custom_fields_responses.field_value

required

Example:

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

stages

object

deprecated

The stages configuration for this request

Show child attributes

stages.requestedItemName

string

required

The name of the requested item

stages.stages

object[]

required

The stages of review for this request

Show child attributes

stages.stages.stage

integer

required

The stage number

stages.stages.operator

enum<string>

required

The operator to apply to reviewers in this stage

Available options:

AND,

OR

stages.stages.reviewers

object[]

required

The reviewers for this stage

Show child attributes

stages.stages.reviewers.id

string<uuid>

required

The unique identifier of the reviewer

stages.stages.reviewers.status

enum<string>

required

The status of this reviewer's review

Available options:

PENDING,

APPROVED,

REJECTED

stages.stages.reviewers.full_name

string

The user's full name.

Example:

"Jake Barnes"

stages.requestedRoleName

string

The name of the requested role

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

reviewer_stages.item_name

string

required

The name of the requested item

reviewer_stages.item_id

string<uuid>

required

The ID of the resource requested.

Example:

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

reviewer_stages.stages

object[]

required

The stages of review for this request

Show child attributes

reviewer_stages.stages.stage

integer

required

The stage number

reviewer_stages.stages.operator

enum<string>

required

The operator to apply to reviewers in this stage

Available options:

AND,

OR

reviewer_stages.stages.reviewers

object[]

required

The reviewers for this stage

Show child attributes

reviewer_stages.stages.reviewers.id

string<uuid>

required

The unique identifier of the reviewer

reviewer_stages.stages.reviewers.status

enum<string>

required

The status of this reviewer's review

Available options:

PENDING,

APPROVED,

REJECTED

reviewer_stages.stages.reviewers.full_name

string

The user's full name.

Example:

"Jake Barnes"

reviewer_stages.access_level_name

string

The name of the access level requested.

Example:

"admin"

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"

Get requests via Relay Post requests approve

⌘I

API Concepts

SDKs

Opal API

Get request by ID

Authorizations

Path Parameters

Response

Request Object

Description

Usage Example