Get Access Request

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

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

fetch('https://api.lumos.com/v1/access-requests/{id}', 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/{id}",
  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/{id}"

	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/{id}")

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

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

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

Get Access Request

Get an access request by ID. Add expand=tasks for the tasks on it that you can see, or expand=custom_fields for the requester’s answers to the app’s intake fields.

Unless you can read every access request in your organization, you can read only the requests you made, the ones made for you, and the ones waiting on your approval. Once a request no longer waits on you, you can’t read it. Any other ID returns 404, the same as one that doesn’t exist.

GET

access-requests

{id}

Get Access Request

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

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

fetch('https://api.lumos.com/v1/access-requests/{id}', 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/{id}",
  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/{id}"

	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/{id}")

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

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

{
  "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.

Path Parameters

string

required

The access request's ID, which GET /v1/access-requests returns as id.

Query Parameters

expand

string[] | null

Fields to expand. Supported values: tasks, custom_fields.

Response

Successful Response

string

required

The ID of the access request.

app_id

string

required

The ID of the app the request is for.

app_name

string

required

The name of the app the request is for.

target_user

User · object

required

The user the request is for.

Show child attributes

status

enum<string>

required

The current status of the request.

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

requester_user

User · object | null

The user who requested access. It's possible for one user to request access on another's behalf. None for system-initiated requests, such as automated onboarding policies, that have no human requester.

Show child attributes

supporter_user

User · object | null

The last approver, other than a manager, who approved or denied this request. None until such an approver acts.

Show child attributes

notes

Notes · object

The reason the user wrote for putting the access request into the given state, keyed by that status.

Show child attributes

expires_at

string<date-time> | null

For time-based access, when the granted access is removed. None for permanent requests.

expiration_in_seconds

integer | null

For time-based access requests, the number of seconds after provisioning at which access should be removed. None for permanent requests.

requested_at

string<date-time> | null

When the request was made.

entitlements

AccessRequestEntitlement · object[]

The entitlements requested.

Show child attributes

tasks

Task · object[] | null

The tasks on this request that the caller can see. Only returned with expand=tasks.

Show child attributes

custom_fields

AccessRequestCustomField · object[] | null

The requester's answers to the app's custom intake fields. Only returned with expand=custom_fields.

Show child attributes

Quick Start

Lumos API

API Reference

Guides

Migrate from v0

Lumos Connectors

Webhooks

Tools

Get Access Request

Authorizations

Path Parameters

Query Parameters

Response