Create Access Request

curl --request POST \
  --url https://api.lumos.com/appstore/access_request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_id": "<string>",
  "requester_user_id": "<string>",
  "target_user_id": "<string>",
  "note": "<string>",
  "business_justification": "<string>",
  "expiration_in_seconds": 123,
  "access_length": "<string>",
  "requestable_permission_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.lumos.com/appstore/access_request"

payload = {
    "app_id": "<string>",
    "requester_user_id": "<string>",
    "target_user_id": "<string>",
    "note": "<string>",
    "business_justification": "<string>",
    "expiration_in_seconds": 123,
    "access_length": "<string>",
    "requestable_permission_ids": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    app_id: '<string>',
    requester_user_id: '<string>',
    target_user_id: '<string>',
    note: '<string>',
    business_justification: '<string>',
    expiration_in_seconds: 123,
    access_length: '<string>',
    requestable_permission_ids: ['<string>']
  })
};

fetch('https://api.lumos.com/appstore/access_request', 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/appstore/access_request",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'app_id' => '<string>',
    'requester_user_id' => '<string>',
    'target_user_id' => '<string>',
    'note' => '<string>',
    'business_justification' => '<string>',
    'expiration_in_seconds' => 123,
    'access_length' => '<string>',
    'requestable_permission_ids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.lumos.com/appstore/access_request"

	payload := strings.NewReader("{\n  \"app_id\": \"<string>\",\n  \"requester_user_id\": \"<string>\",\n  \"target_user_id\": \"<string>\",\n  \"note\": \"<string>\",\n  \"business_justification\": \"<string>\",\n  \"expiration_in_seconds\": 123,\n  \"access_length\": \"<string>\",\n  \"requestable_permission_ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lumos.com/appstore/access_request")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app_id\": \"<string>\",\n  \"requester_user_id\": \"<string>\",\n  \"target_user_id\": \"<string>\",\n  \"note\": \"<string>\",\n  \"business_justification\": \"<string>\",\n  \"expiration_in_seconds\": 123,\n  \"access_length\": \"<string>\",\n  \"requestable_permission_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/appstore/access_request")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app_id\": \"<string>\",\n  \"requester_user_id\": \"<string>\",\n  \"target_user_id\": \"<string>\",\n  \"note\": \"<string>\",\n  \"business_justification\": \"<string>\",\n  \"expiration_in_seconds\": 123,\n  \"access_length\": \"<string>\",\n  \"requestable_permission_ids\": [\n    \"<string>\"\n  ]\n}"

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,
    "requestable_permissions": [
      {
        "label": "<string>",
        "app_id": "<string>",
        "app_class_id": "<string>",
        "app_instance_id": "<string>",
        "id": "<string>",
        "type": "SYNCED",
        "request_config": {
          "appstore_visibility": "HIDDEN",
          "allowed_groups_override": true,
          "allowed_groups": {
            "type": "ALL_GROUPS",
            "groups": []
          },
          "request_approval_config": {
            "manager_approval": "NONE",
            "request_approval_stages": [
              {}
            ]
          },
          "request_fulfillment_config": {},
          "access_removal_inline_webhook": {
            "id": "<string>",
            "hook_type": "PRE_APPROVAL",
            "name": "<string>",
            "description": "<string>"
          },
          "request_validation_inline_webhook": {
            "id": "<string>",
            "hook_type": "PRE_APPROVAL",
            "name": "<string>",
            "description": "<string>"
          }
        }
      }
    ],
    "requested_at": "2023-11-07T05:31:56Z",
    "tasks": [
      {
        "id": "<string>",
        "task_type": "<string>",
        "task_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>",
        "requestable_permission_id": "<string>"
      }
    ],
    "custom_fields": [
      {
        "prompt": "<string>",
        "response": "<string>"
      }
    ]
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

appstore

access_request

Create Access Request

curl --request POST \
  --url https://api.lumos.com/appstore/access_request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_id": "<string>",
  "requester_user_id": "<string>",
  "target_user_id": "<string>",
  "note": "<string>",
  "business_justification": "<string>",
  "expiration_in_seconds": 123,
  "access_length": "<string>",
  "requestable_permission_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.lumos.com/appstore/access_request"

payload = {
    "app_id": "<string>",
    "requester_user_id": "<string>",
    "target_user_id": "<string>",
    "note": "<string>",
    "business_justification": "<string>",
    "expiration_in_seconds": 123,
    "access_length": "<string>",
    "requestable_permission_ids": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    app_id: '<string>',
    requester_user_id: '<string>',
    target_user_id: '<string>',
    note: '<string>',
    business_justification: '<string>',
    expiration_in_seconds: 123,
    access_length: '<string>',
    requestable_permission_ids: ['<string>']
  })
};

fetch('https://api.lumos.com/appstore/access_request', 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/appstore/access_request",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'app_id' => '<string>',
    'requester_user_id' => '<string>',
    'target_user_id' => '<string>',
    'note' => '<string>',
    'business_justification' => '<string>',
    'expiration_in_seconds' => 123,
    'access_length' => '<string>',
    'requestable_permission_ids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.lumos.com/appstore/access_request"

	payload := strings.NewReader("{\n  \"app_id\": \"<string>\",\n  \"requester_user_id\": \"<string>\",\n  \"target_user_id\": \"<string>\",\n  \"note\": \"<string>\",\n  \"business_justification\": \"<string>\",\n  \"expiration_in_seconds\": 123,\n  \"access_length\": \"<string>\",\n  \"requestable_permission_ids\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lumos.com/appstore/access_request")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app_id\": \"<string>\",\n  \"requester_user_id\": \"<string>\",\n  \"target_user_id\": \"<string>\",\n  \"note\": \"<string>\",\n  \"business_justification\": \"<string>\",\n  \"expiration_in_seconds\": 123,\n  \"access_length\": \"<string>\",\n  \"requestable_permission_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumos.com/appstore/access_request")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app_id\": \"<string>\",\n  \"requester_user_id\": \"<string>\",\n  \"target_user_id\": \"<string>\",\n  \"note\": \"<string>\",\n  \"business_justification\": \"<string>\",\n  \"expiration_in_seconds\": 123,\n  \"access_length\": \"<string>\",\n  \"requestable_permission_ids\": [\n    \"<string>\"\n  ]\n}"

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,
    "requestable_permissions": [
      {
        "label": "<string>",
        "app_id": "<string>",
        "app_class_id": "<string>",
        "app_instance_id": "<string>",
        "id": "<string>",
        "type": "SYNCED",
        "request_config": {
          "appstore_visibility": "HIDDEN",
          "allowed_groups_override": true,
          "allowed_groups": {
            "type": "ALL_GROUPS",
            "groups": []
          },
          "request_approval_config": {
            "manager_approval": "NONE",
            "request_approval_stages": [
              {}
            ]
          },
          "request_fulfillment_config": {},
          "access_removal_inline_webhook": {
            "id": "<string>",
            "hook_type": "PRE_APPROVAL",
            "name": "<string>",
            "description": "<string>"
          },
          "request_validation_inline_webhook": {
            "id": "<string>",
            "hook_type": "PRE_APPROVAL",
            "name": "<string>",
            "description": "<string>"
          }
        }
      }
    ],
    "requested_at": "2023-11-07T05:31:56Z",
    "tasks": [
      {
        "id": "<string>",
        "task_type": "<string>",
        "task_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>",
        "requestable_permission_id": "<string>"
      }
    ],
    "custom_fields": [
      {
        "prompt": "<string>",
        "response": "<string>"
      }
    ]
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

app_id

string

required

requester_user_id

string

Override the user who made the request. If omitted, use the current user. Only available to organization admins.

target_user_id

string

User to request access for. If omitted, request for the current user.

note

string | null

[Deprecated - use business_justification] Why the user needs access.

business_justification

string | null

Why the user needs access.

expiration_in_seconds

integer | null

Once granted, how long the access should last. Omit for permanent access.

access_length

string | null

Once granted, how long the access should last. Omit for permanent access. All possible values are '2 hours', '4 hours', '8 hours', '12 hours', '1 day', '2 days', '3 days', '7 days', '14 days', '30 days', '90 days', 'Unlimited', but the exact options depend on the settings of the app and permissions.

requestable_permission_ids

string[] | null

The IDs of the requestable permissions the user is requesting access to. Omit this to just request access to the app.

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 user supporting this request, if any. None if no supporter has been assigned.

Show child attributes

notes

Notes · object

The reason the user wrote for putting the access request into the given state.

Show child attributes

expires_at

string<date-time> | null

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.

requestable_permissions

RequestablePermissionOutput · object[] | null

Show child attributes

requested_at

string<date-time> | null

tasks

Task · object[] | null

Show child attributes

custom_fields

CustomIntakeFieldResponseOutput · object[] | null

Show child attributes

Quickstart

Lumos Connectors

Lumos

Guides

Webhooks

Examples

Tools

Recipes

Create Access Request

Authorizations

Body

Response