Skip to main content
GET
Get Entitlement

Authorizations

Authorization
string
header
required

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

Path Parameters

entitlement_uuid
string
required

The entitlement's ID, which GET /v1/entitlements and GET /v1/apps/{app_uuid}/entitlements return as id.

Query Parameters

expand
string[] | null

Fields to expand. Supported fields: approval_workflow_override, provisioning_workflow, deprovisioning_workflow, appstore_settings.

Response

Successful Response

Public-API representation of an Entitlement.

id
string
required

The ID of this entitlement.

app_id
string
required

The ID of the app that owns this entitlement.

label
string
required

Human-readable label for the entitlement (e.g. a role or license name).

entitlement_type_label
string
required

Human-readable label for the entitlement's type (e.g. 'Role', 'License', 'Group').

source
enum<string>
required

How this entitlement was discovered. manual is created in Lumos; other values come from an upstream integration.

Available options:
google-workspace-quick-inbox,
google-workspace-deep-inbox,
microsoft-deep-inbox,
microsoft-oauth,
microsoft-gcc,
google-workspace-oauth,
okta,
manual,
onelogin,
atlassian,
google-cloud,
integration,
jumpcloud,
custom,
mcp,
native
description
string | null

The description shown to requesters: description_override if set, otherwise the integration's own description. Read-only; set description_override instead.

description_override
string | null

The description set in Lumos, kept across syncs. Null when none is set, and the entitlement shows its integration's description.

approval_workflow_override
Workflow · object

Response shape for a Workflow.

provisioning_workflow
Workflow · object

Response shape for a Workflow.

deprovisioning_workflow
Workflow · object

Response shape for a Workflow.

custom_approval_message_override
string | null

This entitlement's own custom approval message, shown to requesters when the entitlement is approved, overriding the app's. Null means this entitlement inherits the app's approval message.

appstore_settings
EntitlementAppStoreSettings · object | null

The entitlement's AppStore-catalog settings. Null unless expanded with expand=appstore_settings. Omitted entirely (not present, not null) when the parent app isn't enrolled in the AppStore.