Skip to main content
GET
Get AppStore Settings

Authorizations

Authorization
string
header
required

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

Path Parameters

app_uuid
string
required

The app's ID, which GET /v1/apps returns as id.

Response

Successful Response

allow_permission_selection
boolean
required

When true, requesters may select which entitlement to request. When false, the default entitlement is used automatically and only approvers can change it. An app that was never configured reports the value Lumos applies when validating its access requests, which may be false.

allow_multiple_permission_selection
boolean
required

When true, requesters may select more than one entitlement in a single request.

time_based_access
TimeBasedAccess · object
required

Time-based access configuration for this app.

in_app_store
boolean
required

Whether this app is listed in the AppStore catalog.

catalog_visibility
enum<string>
required

Visibility of the app within the catalog. "visible" — shown in browse and search; "search-only" — returned only by search, not in browse; "hidden" — enrolled but not visible to requesters.

Available options:
visible,
search-only,
hidden
request_instructions
string | null

Custom instructions shown to a requester when they open the access-request form. Null means no custom instructions are set.

allowed_requester_group_uuids
string[] | null

UUIDs of the groups whose members may request this app. Null means everyone in your organization can request the app.

request_validation_webhook_uuid
string | null

UUID of the inline webhook called to validate access requests before approval. Null means no validation webhook is configured.

redirect_url
string | null

If set, requesting this app redirects the user to this URL instead of going through the normal access-request flow. Null means no redirect is configured. Max 2048 characters.

Maximum string length: 2048
default_entitlement
EntitlementRef · object | null

The entitlement pre-selected by default when a user opens the request form. Null means no default is set.

custom_intake_fields
CustomIntakeField · object[] | null

Custom form questions shown to requesters before they submit an access request. Null means no custom fields are configured.