List Access Requests

curl --request GET \
  --url https://api.lumos.com/v1/access-requests \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lumos.com/v1/access-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/access-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/access-requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/access-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "access_requests": [
    {
      "id": "<string>",
      "app_id": "<string>",
      "app_name": "<string>",
      "target_user": {
        "id": "<string>",
        "email": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "status": "staged"
      },
      "status": "pending",
      "requester_user": {
        "id": "<string>",
        "email": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "status": "staged"
      },
      "supporter_user": {
        "id": "<string>",
        "email": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "status": "staged"
      },
      "notes": {},
      "expires_at": "2023-11-07T05:31:56Z",
      "expiration_in_seconds": 123,
      "requested_at": "2023-11-07T05:31:56Z",
      "entitlements": [
        {
          "id": "<string>",
          "label": "<string>"
        }
      ],
      "tasks": [
        {
          "id": "<string>",
          "type": "access-request-approval",
          "category": "manager-approval",
          "status": "pending",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "instructions": "<string>",
          "product_area": "access-reviews",
          "app": {
            "id": "<string>"
          },
          "target_user": {
            "id": "<string>",
            "email": "<string>",
            "given_name": "<string>",
            "family_name": "<string>",
            "status": "staged"
          },
          "resolved_by": {
            "id": "<string>",
            "email": "<string>",
            "given_name": "<string>",
            "family_name": "<string>",
            "status": "staged"
          },
          "assignees": [
            {
              "id": "<string>",
              "type": "user",
              "name": "<string>",
              "email": "<string>"
            }
          ],
          "actions": [
            {
              "action_type": "<string>",
              "transitions": [
                {
                  "transition_to": "pending"
                }
              ]
            }
          ],
          "comments": [
            {
              "body": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": {
                "id": "<string>",
                "email": "<string>",
                "given_name": "<string>",
                "family_name": "<string>",
                "status": "staged"
              }
            }
          ],
          "access_request_id": "<string>",
          "entitlement_id": "<string>"
        }
      ],
      "custom_fields": [
        {
          "prompt": "<string>",
          "reference_key": "<string>",
          "response": "<string>"
        }
      ]
    }
  ],
  "next_page_token": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Access Requests

List Access Requests

List the access requests in your organization. A user_id, target_user_id, or requester_user_id that matches no user in your organization returns 404.

Paginated via opaque cursor: pass the next_page_token value from the previous response back as the page_token query parameter to fetch the next page. When next_page_token is null, the current page is the last one. A page_token is only valid with the same filters and order_by as the request that returned it.

GET

access-requests

curl --request GET \
  --url https://api.lumos.com/v1/access-requests \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.lumos.com/v1/access-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumos.com/v1/access-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumos.com/v1/access-requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/v1/access-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "access_requests": [
    {
      "id": "<string>",
      "app_id": "<string>",
      "app_name": "<string>",
      "target_user": {
        "id": "<string>",
        "email": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "status": "staged"
      },
      "status": "pending",
      "requester_user": {
        "id": "<string>",
        "email": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "status": "staged"
      },
      "supporter_user": {
        "id": "<string>",
        "email": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "status": "staged"
      },
      "notes": {},
      "expires_at": "2023-11-07T05:31:56Z",
      "expiration_in_seconds": 123,
      "requested_at": "2023-11-07T05:31:56Z",
      "entitlements": [
        {
          "id": "<string>",
          "label": "<string>"
        }
      ],
      "tasks": [
        {
          "id": "<string>",
          "type": "access-request-approval",
          "category": "manager-approval",
          "status": "pending",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "instructions": "<string>",
          "product_area": "access-reviews",
          "app": {
            "id": "<string>"
          },
          "target_user": {
            "id": "<string>",
            "email": "<string>",
            "given_name": "<string>",
            "family_name": "<string>",
            "status": "staged"
          },
          "resolved_by": {
            "id": "<string>",
            "email": "<string>",
            "given_name": "<string>",
            "family_name": "<string>",
            "status": "staged"
          },
          "assignees": [
            {
              "id": "<string>",
              "type": "user",
              "name": "<string>",
              "email": "<string>"
            }
          ],
          "actions": [
            {
              "action_type": "<string>",
              "transitions": [
                {
                  "transition_to": "pending"
                }
              ]
            }
          ],
          "comments": [
            {
              "body": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": {
                "id": "<string>",
                "email": "<string>",
                "given_name": "<string>",
                "family_name": "<string>",
                "status": "staged"
              }
            }
          ],
          "access_request_id": "<string>",
          "entitlement_id": "<string>"
        }
      ],
      "custom_fields": [
        {
          "prompt": "<string>",
          "reference_key": "<string>",
          "response": "<string>"
        }
      ]
    }
  ],
  "next_page_token": "<string>"
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "detail": "<string>",
    "type": "validation",
    "code": "<string>",
    "errors": [
      {
        "field": "<string>",
        "code": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

order_by

enum<string> | null

Sort by when the request was made: created_at for oldest first (the default), created_at desc for newest first.

Available options:

created_at,

created_at desc

expand

string[] | null

Fields to expand. Supported values: tasks, custom_fields.

page_token

string | null

Opaque cursor from a previous response's next_page_token. Omit to fetch the first page. Treat as opaque: do not decode, construct, or interpret it.

page_size

integer

default:100

Maximum number of items to return per page. Values above 1000 are clamped to 1000 rather than rejected.

Required range: x >= 1

target_user_id

string | null

Filters requests by the ID of the target user.

requester_user_id

string | null

Filters requests by the ID of the requesting user.

user_id

string | null

Filters requests by the ID of the user.

statuses

enum<string>[] | null

Filters requests by their status. Possible values: 'pending', 'pending-manager-approval', 'manager-approved', 'manager-denied', 'pending-approval', 'approved', 'denied', 'expired', 'cancelled', 'pending-provisioning', 'pending-manual-provisioning', 'denied-provisioning', 'provisioned', 'pending-deprovisioning', 'pending-manual-deprovisioning', 'time-based-expired', 'completed', 'reverting', 'reverted', 'time-based-expired-failed', 'time-based-expired-cancelled'

Available options:

pending,

pending-manager-approval,

manager-approved,

manager-denied,

pending-approval,

approved,

denied,

expired,

cancelled,

pending-provisioning,

pending-manual-provisioning,

denied-provisioning,

provisioned,

pending-deprovisioning,

pending-manual-deprovisioning,

time-based-expired,

completed,

reverting,

reverted,

time-based-expired-failed,

time-based-expired-cancelled

Response

Successful Response

access_requests

AccessRequest · object[]

required

Access requests returned in this page.

Show child attributes

next_page_token

string | null

Token for the next page, or null when this is the last page. An absent token is the only end-of-results signal. A page holding fewer than page_size items does not mean the results are exhausted. Treat the value as opaque: do not decode, construct, or interpret it.

Quick Start

Lumos API

API Reference

Guides

Migrate from v0

Lumos Connectors

Webhooks

Tools

List Access Requests

Authorizations

Query Parameters

Response