Lumos REST API
The Lumos REST API enables programmatic access to the Lumos identity platform for automating tasks such as managing users, apps, access requests, and governance workflows. All requests require a bearer token (prefixed lsk_) in the Authorization header.
Lumos REST API is one of 16 APIs that Lumos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Access Management, Automation, Governance, and Identity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes 89 operations across 64 paths, organized into 9 resource areas, and defines 189 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.
Requests are made against a single base URL, https://api.lumos.com.
89 operations
64 paths
189 schemas
10 DELETE45 GET7 PATCH24 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Lumos REST API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (HTTPBearer).
Paths & Operations 89
Across 64 paths, the API surfaces 89 operations — 10 DELETE, 45 GET, 7 PATCH, 24 POST, 3 PUT. They span 9 resource areas: Core, AppStore, Access Reviews, Knowledge, Vendor Management, Tasks, Lifecycle Management, Meta, Integration Webhooks. Each is listed below with its method, path, parameters, and response codes.
Core 36
GET
/apps
Get Apps
POST
/apps
Create App
GET
/apps/categories
Get App Categories
GET
/apps/{app_id}
Get App
PATCH
/apps/{app_id}
Update App
PUT
/apps/{app_id}
Reconnect App
DELETE
/apps/{app_id}
Disconnect App
GET
/apps/{app_id}/settings
Get Appstore App Settings
PATCH
/apps/{app_id}/settings
Update Domain App Appstore Settings
GET
/users/current
Get Current User
GET
/users
Get Users
GET
/users/{user_id}
Get User
GET
/users/{user_id}/accounts
Get User Accounts
GET
/inline_webhooks
Get Inline Webhooks
GET
/accounts
Get Accounts
GET
/groups/{group_id}/users
Get Group Membership
GET
/groups/{group_id}
Get Group
GET
/groups
Get Groups
GET
/accounts/upload/{job_id}
Get Upload Job State
GET
/activity_logs
Get Activity Logs
GET
/identity_events
Get Identity Events
POST
/apps/{app_id}/sync
Trigger App Sync
GET
/integrations
List Integrations
GET
/integrations/{app_class_id}
Get Integration
GET
/integrations/{app_class_id}/connection-schema
Get Integration Connection Schema
POST
/accounts/upload
Create Accounts
POST
/activity_records
Update Activity Records
GET
/activity_records/job/{job_id}
Get Activity Records Job State
GET
/users/{user_id}/roles
Get User Roles
POST
/users/{user_id}/roles/{role_name}
Add Role To User
DELETE
/users/{user_id}/roles/{role_name}
Remove Role From User
GET
/access_policies
Get Access Policies
POST
/access_policies
Create Access Policy
GET
/access_policies/{access_policy_id}
Get Access Policy
DELETE
/access_policies/{access_policy_id}
Delete Access Policy
PUT
/access_policies/{access_policy_id}
Update Access Policy
AppStore 21
GET
/appstore/apps/{app_id}/requestable_permissions
Get Appstore Permissions For App
GET
/appstore/requestable_permissions
Get Appstore Permissions
POST
/appstore/requestable_permissions
Create Appstore Requestable Permission
GET
/appstore/requestable_permissions/{permission_id}
Get Appstore Permission
PATCH
/appstore/requestable_permissions/{permission_id}
Update Appstore Permission
DELETE
/appstore/requestable_permissions/{permission_id}
Delete Appstore Permission
GET
/appstore/pre_approval_rules
Get Appstore Pre Approval Rules For App
POST
/appstore/pre_approval_rules
Create Pre Approval Rule
GET
/appstore/pre_approval_rules/{pre_approval_rule_id}
Get Appstore Pre Approval Rule
PATCH
/appstore/pre_approval_rules/{pre_approval_rule_id}
Update Pre Approval Rule
DELETE
/appstore/pre_approval_rules/{pre_approval_rule_id}
Delete Pre Approval Rule
GET
/appstore/apps/{app_id}/settings
Get Appstore App Settings
PATCH
/appstore/apps/{app_id}/settings
Update Appstore App Settings
POST
/appstore/apps
Add App To Appstore
GET
/appstore/apps
Get Appstore Apps
DELETE
/appstore/apps/{app_id}
Remove App From Appstore
GET
/appstore/apps/{app_id}
Get Appstore App
DELETE
/appstore/access_requests/{id}
Cancel Access Request
GET
/appstore/access_requests/{id}
Get Access Request
POST
/appstore/access_request
Create Access Request
GET
/appstore/access_requests
Get Access Requests
Access Reviews 8
Create and manage access review campaigns — scheduled reviews of who has access to what across your connected apps. Typical workflow for creating a review: 1. GET /apps — find the…
POST
/access_reviews
Create Access Review
GET
/access_reviews
List Access Reviews
POST
/access_reviews/{access_review_id}/apps
Add Apps To Access Review
DELETE
/access_reviews/{access_review_id}
Delete Access Review
GET
/access_reviews/{access_review_id}
Get Access Review
PATCH
/access_reviews/{access_review_id}
Update Access Review
DELETE
/access_reviews/{access_review_id}/apps/{arda_id}
Delete Access Review App
GET
/access_reviews/scope_options
Get Scope Options Endpoint
Knowledge 5
Knowledge entries are the documents and notes Lumos agents draw on when they answer access questions. Each entry carries a title, body, tags, and product scopes, plus an optional…
GET
/v1/knowledge/context
List Knowledge Context
POST
/v1/knowledge/context
Create Knowledge Context
GET
/v1/knowledge/context/{knowledge_context_id}
Get Knowledge Context
PATCH
/v1/knowledge/context/{knowledge_context_id}
Update Knowledge Context
DELETE
/v1/knowledge/context/{knowledge_context_id}
Delete Knowledge Context
Vendor Management 4
GET
/vendor_agreements
Get Vendor Agreements
PUT
/vendor_agreements/{vendor_agreement_id}/custom_attributes/{label}
Update Vendor Agreement Custom Attribute
POST
/found_documents
Upload Found Documents
POST
/orders
Upload Order
Tasks 8
Tasks are work items emitted by Lumos workflows — things that need a human (or an automated caller) to make a decision or perform a step before the workflow can proceed. Typical e…
GET
/tasks
List Tasks
GET
/tasks/{task_id}
Get Task
GET
/tasks/{task_id}/actions
Get Task Actions
POST
/tasks/{task_id}/perform-action
Perform Task Action
POST
/tasks/{task_id}/reassign
Reassign Task
POST
/tasks/{task_id}/comments
Add Task Comment
POST
/tasks/{task_id}/complete
Complete Task
POST
/tasks/{task_id}/dismiss
Dismiss Task
Lifecycle Management 3
POST
/lifecycle-management/user-offboardings
Create User Offboarding
GET
/lifecycle-management/user-offboardings/{user_offboarding_id}
Get User Offboarding
POST
/lifecycle-management/user-offboardings/{user_offboarding_id}/cancel
Cancel User Offboarding
Meta 2
GET
/art
Get Art
GET
/info
Get Info
Integration Webhooks 2
POST
/webhooks/airbase/purchase_request_approved/{domain_app_uuid}
Process Airbase Purchase Request Approved
POST
/webhooks/vendr/request_completed/{domain_app_uuid}
Process Vendr Request Completed
Schemas 189
The contract defines 189 schemas that model the data the API accepts and returns. The most detailed are Condition-Input (17 properties), Condition-Output (17 properties), Task (17 properties), AppStoreApp (16 properties). Each schema is shown below with its type and property counts.
AccessPolicyAppInput
object
An app granted by this access policy. Extends BaseApp with access-policy-specific fields.
3 properties
1 required
AccessPolicyAppOutput
object
An app granted by this access policy. Extends BaseApp with access-policy-specific fields.
4 properties
4 required
AccessPolicyInput
object
7 properties
3 required
AccessPolicyOutput
object
The full representation of an access policy returned by the API.
8 properties
8 required
AccessPolicyPermissionInput
object
A permission for a given app granted by this access policy. Inherits RequestablePermissionBase fields (i.e. id)
1 property
AccessPolicyPermissionOutput
object
A permission for a given app granted by this access policy. Inherits RequestablePermissionBase fields (i.e. id)
2 properties
1 required
AccessRequest
object
API version of DomainAppSupportRequest.
14 properties
5 required
AccessReviewDomainAppConfigurableEvidenceUpload
string
Every operation requires evidence upload for failures and manual actions.
AccessReviewDomainAppErrorOutput
object
2 properties
2 required
AccessReviewDomainAppInput
object
3 properties
1 required
AccessReviewDomainAppOutput
object
12 properties
5 required
AccessReviewOutput
object
15 properties
4 required
AccessReviewRemovalAction
string
Account
object
12 properties
4 required
AccountLifecycleStatus
string
NOTE: If you update this, also update UserDomainAppLifecycleStatus DISCOVERED - Account discovered through accountfinding. Could be noisy. STAGED - An account…
AccountType
string
ActivityLog
object
API version of SIEMEvent
8 properties
7 required
ActivityRecord
object
5 properties
4 required
ActivityRecordAccountInput
object
2 properties
ActivityRecordAppInput
object
1 property
1 required
ActivityRecordEventInput
object
1 property
1 required
ActivityRecordEventType
string
ActivityRecordInput
object
1 property
1 required
ActivityRecordOutput
object
1 property
1 required
AddAppToAppStoreInput
object
5 properties
1 required
AddAppsInput
object
1 property
1 required
AddAppsOutput
object
2 properties
1 required
AddCommentInput
object
1 property
1 required
AirbasePurchaseRequestEvent
object
Model of the input we'll get from Airbase's webhook call. All events seem to follow this same base structure, it is just data that is different for each. We ar…
5 properties
5 required
AllowedGroupsConfigInput
object
2 properties
AllowedGroupsConfigOutput
object
2 properties
AllowedGroupsConfigType
string
ApiError
object
The V1 error envelope.
4 properties
3 required
ApiErrorField
object
A single field-level error (used for validation failures).
3 properties
3 required
App
object
15 properties
9 required
AppAdminsInput
object
2 properties
AppAdminsOutput
object
2 properties
AppApproversInput
object
2 properties
AppApproversOutput
object
2 properties
AppInputCreate
object
Body of POST /apps: create a custom app, or connect an integration. One flat model serves both operations (a request-body union would generate poorly into SDK/…
10 properties
AppInputPut
object
Body of PUT /apps/{appid}: update metadata overrides and/or reconnect. One flat model serves both operations (mirroring AppInputCreate): the metadata fields ap…
10 properties
AppInputUpdate
object
6 properties
AppLinks
object
2 properties
2 required
AppSettingInput
object
5 properties
AppSettingOutput
object
5 properties
AppStoreApp
object
16 properties
9 required
AppStoreAppSettingsInput
object
4 properties
AppStoreAppSettingsOutput
object
4 properties
AppStoreAppSettingsProvisioningInput
object
9 properties
AppStoreAppSettingsProvisioningOutput
object
9 properties
AppStoreAppSettingsRequestFlowInput
object
9 properties
AppStoreAppSettingsRequestFlowOutput
object
10 properties
AppStoreVisibility
string
AppStoreVisibilityOption
string
AppWithCustomAttributes
object
16 properties
9 required
ApplicationTagOutput
object
2 properties
2 required
ApproverInput
object
3 properties
ApproverOutput
object
3 properties
1 required
ApproverType
string
AttributeEqualityRule
object
2 properties
2 required
AttributeOperand
object
2 properties
2 required
BaseApp
object
1 property
1 required
BaseGroup
object
3 properties
BaseInlineWebhook
object
1 property
1 required
BaseUser
object
1 property
1 required
Body_createKnowledgeContext
object
5 properties
1 required
Body_updateKnowledgeContext
object
6 properties
Condition-Input
object
Pydantic model describing a Lumos Condition shape. This model may be used to validate any input Condition JSON across services that expose interacting with Lum…
17 properties
Condition-Output
object
Pydantic model describing a Lumos Condition shape. This model may be used to validate any input Condition JSON across services that expose interacting with Lum…
17 properties
ConnectionSource
string
Tracks how a domain app integration was initiated.
Cost
object
2 properties
1 required
CreateAccessRequestInput
object
8 properties
1 required
CreateAccessReviewInput
object
7 properties
2 required
CreateAccessReviewOutput
object
2 properties
1 required
CustomAttribute
object
2 properties
1 required
CustomAttributeScopeFilterInput
object
Scope filter for CUSTOMATTRIBUTE groups. Custom attributes are keyed by name (the attribute label, e.g. "Department"). type declares the attribute's type (STRI…
5 properties
3 required
CustomAttributeType
string
CustomIntakeFieldResponseOutput
object
API version of a CustomIntakeFieldResponse on an access request.
2 properties
1 required
DatetimeScopeFilterInput
object
Scope filter for datetime-valued groups (LASTLOGIN, LASTACTIVITY). Provide after, before, or both. Bounds are inclusive. At least one must be set. - after alon…
3 properties
1 required
DisconnectIntegrationOutput
object
3 properties
3 required
DiscoverySource
string
DomainAppStatus
string
ErrorType
string
FileUpload
object
2 properties
2 required
FileUploadType
string
FlowState
string
FlowsV2NormalizedDisplayStatus
string
FoundDocumentsUpload
object
8 properties
2 required
Group
object
7 properties
GroupProvisioningOption
string
HTTPValidationError
object
1 property
IdentityEvent
object
API representation of a identity event.
6 properties
4 required
IdentityEventsResult
object
Paginated list of identity events.
3 properties
2 required
InlineWebhook
object
4 properties
3 required
InlineWebhookType
string
IntegrationCatalogOutput
object
A connectable integration from the app catalog (not a connected instance). Read via GET /integrations and GET /integrations/{appclassid}. Carries catalog metad…
5 properties
2 required
IntegrationConnectionSchemaOutput
object
An integration's connection schema — the auth and settings a caller must supply to connect it — so the Terraform provider and SDK consumers can discover how to…
3 properties
3 required
JobStateOutput
object
2 properties
1 required
KnowledgeContextOutput
object
9 properties
5 required
KnowledgeProductScope
string
Lifecycle
string
LimitOffsetPage_ActivityLog_
object
5 properties
5 required
LineItem
object
6 properties
6 required
LineItemInput
object
6 properties
6 required
LineItemUnitCost
object
1 property
1 required
LineItemUnitCostInput
object
2 properties
2 required
LineItemUpload
object
3 properties
3 required
Links
object
5 properties
5 required
ListKnowledgeContextOutput
object
2 properties
1 required
ManagerApprovalOption
string
OrderInput
object
10 properties
6 required
Page_AccessPolicyOutput_
object
5 properties
4 required
Page_AccessRequest_
object
5 properties
4 required
Page_AccessReviewOutput_
object
5 properties
4 required
Page_Account_
object
5 properties
4 required
Page_AppStoreApp_
object
5 properties
4 required
Page_AppWithCustomAttributes_
object
5 properties
4 required
Page_Group_
object
5 properties
4 required
Page_IntegrationCatalogOutput_
object
5 properties
4 required
Page_PreApprovalRuleOutput_
object
5 properties
4 required
Page_RequestablePermissionOutput_
object
5 properties
4 required
Page_Task_
object
5 properties
4 required
Page_UserWithCustomAttributes_
object
5 properties
4 required
Page_User_
object
5 properties
4 required
Page_VendorAgreement_
object
5 properties
4 required
PerformTaskActionInput
object
2 properties
1 required
PermissionType
string
PositionalWeekday
object
A positional weekday for monthly/yearly recurrences — e.g. "the first Monday of the month" is {"weekday": 0, "n": 1}. Mirrors dateutil.rrule.weekday. A plain i…
2 properties
1 required
PreApprovalRuleInput
object
7 properties
2 required
PreApprovalRuleOutput
object
10 properties
4 required
PreApprovalRuleUpdateInput
object
6 properties
1 required
ProductArea
string
ReassignTaskInput
object
3 properties
RecurrenceConfig
object
Shape of a recurrence configuration. Fields map directly to dateutil.rrule kwargs. See https://dateutil.readthedocs.io/en/stable/rrule.html for full documentat…
14 properties
1 required
RecurrenceConfigInput
object
Extends RecurrenceConfig with rrule semantic validation for use on write paths.
14 properties
1 required
RequestApprovalConfigInput
object
8 properties
RequestApprovalConfigOutput
object
9 properties
RequestApprovalStageInput
object
1 property
RequestApprovalStageOutput
object
1 property
RequestConfigInputCreate
object
7 properties
RequestConfigInputUpdate
object
7 properties
RequestConfigOutput
object
7 properties
RequestFulfillmentConfigInput
object
6 properties
RequestFulfillmentConfigInputUpdate
object
5 properties
RequestFulfillmentConfigOutput
object
6 properties
RequestablePermissionBase
object
1 property
RequestablePermissionBaseOutput
object
6 properties
4 required
RequestablePermissionInput
object
5 properties
2 required
RequestablePermissionInputUpdate
object
5 properties
RequestablePermissionOutput
object
7 properties
4 required
ReviewType
string
RunInfoStatus
string
ScalarScopeFilterInput
object
Scope filter for groups whose value is a simple string/UUID/enum. Datetime-valued groups (LASTLOGIN, LASTACTIVITY) use :class:DatetimeScopeFilterInput; CUSTOMA…
5 properties
3 required
ScopablePropertyGroup
string
ScopeFilterGroupOutput
object
Self-describing discovery group. Each entry in items is a valid :type:ScopeFilterInput payload — the caller can POST it back unmodified in a create/edit reques…
7 properties
3 required
ScopeOptionsResponse
object
1 property
1 required
SupportRequestStatus
string
SyncStatus
string
SyncTaskOutput
object
2 properties
1 required
SyncType
string
The kind of sync to trigger. MVP supports full integration sync only. The enum is the forward-compatible seam: new sync kinds (incremental, groups-only, …) are…
Task
object
17 properties
6 required
TaskAction
object
2 properties
2 required
TaskActionTransition
object
1 property
TaskAssignee
object
4 properties
2 required
TaskAssigneeType
string
TaskCategory
string
TaskComment
object
3 properties
2 required
TaskProductArea
string
TaskStatus
string
TriggerSyncInput
object
1 property
1 required
TriggerSyncOutput
object
3 properties
3 required
UpdateAccessReviewArdaInput
object
4 properties
1 required
UpdateAccessReviewInput
object
7 properties
User
object
5 properties
1 required
UserLifecycleStatus
string
UserOffboardingInput
object
2 properties
1 required
UserOffboardingOutput
object
7 properties
7 required
UserWithCustomAttributes
object
6 properties
1 required
ValidationError
object
3 properties
3 required
ValueOption
object
Pydantic model describing a Value Option shape. Conditions may allow specifying a ValueOption in place of a ConditionValue when a human-readable label is desir…
2 properties
2 required
Vendor
object
1 property
1 required
VendorAgreement
object
14 properties
11 required
VendorAgreementCustomAttribute-Input
object
2 properties
1 required
VendorAgreementCustomAttribute-Output
object
2 properties
1 required
VendorAgreementCustomAttributeType
string
VendorAgreementCustomAttributeUpdateInput
object
1 property
AccountInput
object
9 properties
1 required
AttributeInput
object
3 properties
PermissionInput
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Lumos 12
Other APIs Lumos publishes across the network.
Lumos Connector SDK
Lumos AccessPolicies API
Lumos AccessRequests API
Lumos AccessReviews API
Lumos Accounts API
Lumos Activity API
Lumos Apps API
Lumos AppStore API
Lumos Groups API
Lumos PreApprovalRules API
Lumos Tasks API
Lumos Users API
#Access Management#Automation#Governance#Identity
Where this information came from
This is an independent, third-party profile of Lumos REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.