v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
requests

Get requests via Relay

Returns a paginated list of requests using Relay-style cursor pagination.

get/requests/relay

Query parameters

firstinteger

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

afterstring

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

lastinteger

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

beforestring

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

status'PENDING' | 'APPROVED' | 'DENIED' | 'CANCELED'

Request Status

Description

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

Usage Example

Returned from the GET Requests endpoint.

Filter requests by their status.

tostring uuid

Filter requests assigned to a specific user ID.

fromstring uuid

Filter requests made by a specific user ID.

Response

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

totalCountinteger required

The total number of items available

Example response

{
  "edges": [
    {
      "node": {
        "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
        "created_at": "2021-01-06T20:00:00Z",
        "updated_at": "2021-01-06T20:00:00Z",
        "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:00Z",
            "updated_at": "2021-01-06T20:00:00Z",
            "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"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}