Skip to content
Entitlements module/
/
Get single entitlement

Entitlements Overview (1.0)

The Entitlements Engine is powered by the isEntitledTo query and is designed to manage and control user access within your application. It enables you to grant users specific roles, permissions, feature access, and more, providing a flexible framework for access management.

Below is an overview of API endpoints relevant to managing features, plans, feature flags, and API access control within your application. All endpoints are classified as Management Endpoints, requiring environment-level authorization and offering comprehensive control over entitlement resources.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
Languages
Servers
EU Region
https://api.frontegg.com/entitlements/
US Region
https://api.us.frontegg.com/entitlements/
CA Region
https://api.ca.frontegg.com/entitlements/
AU Region
https://api.au.frontegg.com/entitlements/
Frontegg sub-domain for use with user tokens
https://{domain}.frontegg.com/entitlements/

ReBAC

Operations

Features

Operations

Plans

Operations

Entitlements

Operations

Batch delete entitlements

Request

Delete multiple entitlements in a single batch operation by providing an array of entitlement IDs, enabling efficient bulk removal of entitlements.

Security
bearer
Query
idsArray of stringsrequired

UUID string that represents the entitlement ID

Example: ids=e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3
curl -i -X DELETE \
  'https://api.frontegg.com/entitlements/resources/entitlements/v2/batch?ids=e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Get single entitlement

Request

Retrieve detailed information for a specific entitlement by its unique ID, including associated plan details and metadata.

Security
bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.frontegg.com/entitlements/resources/entitlements/v2/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired

UUID string that represents the entitlement ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
planIdstringrequired

UUID string that represents the plan ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
tenantIdstringrequired

UUID string that represents the account (tenant) ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
userIdstring

UUID string that represents the user ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
expirationDatestring(date-time)

Date of entitlement expiration

Example: "2022-01-01T12:00:00"
createdAtstring(date-time)required

Date when entitlement was created

Example: "2022-01-01T12:00:00"
updatedAtstring(date-time)

Date when entitlement was last updated

Example: "2022-01-01T12:00:00"
planobjectrequired
plan.​idstringrequired

UUID string that represents the plan ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
plan.​vendorIdstringrequired

UUID string that represents the vendor ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
plan.​namestringrequired

String that represents the plan name

Example: "Test Plan"
plan.​defaultTimeLimitationnumber

Number that represents the default time limitation in days for auto-assigned plans

Example: "30"
plan.​descriptionstring

Feature plan description

Example: "This is a test plan"
plan.​createdAtstringrequired

Date when plan was created

Example: "2022-01-01T00:00:00"
plan.​updatedAtstring

Date when plan was last updated

Example: "2022-01-01T00:00:00"
Response
application/json
{
  "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "planId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "tenantId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "userId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "expirationDate": "2022-01-01T12:00:00",
  "createdAt": "2022-01-01T12:00:00",
  "updatedAt": "2022-01-01T12:00:00",
  "plan": {
    "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "vendorId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "name": "Test Plan",
    "defaultTimeLimitation": "30",
    "description": "This is a test plan",
    "createdAt": "2022-01-01T00:00:00",
    "updatedAt": "2022-01-01T00:00:00"
  }
}

Update entitlement

Request

Update an existing entitlement's properties, such as expiration date, by providing the entitlement ID and the fields to modify.

Security
bearer
Path
idstringrequired
Bodyapplication/jsonrequired
expirationDatestring(date-time)

Date of entitlement expiration

Example: "2022-01-01T12:00:00"
curl -i -X PATCH \
  'https://api.frontegg.com/entitlements/resources/entitlements/v2/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "expirationDate": "2022-01-01T12:00:00"
  }'

Responses

Bodyapplication/json
idstringrequired

UUID string that represents the entitlement ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
planIdstringrequired

UUID string that represents the plan ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
tenantIdstringrequired

UUID string that represents the account (tenant) ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
userIdstring

UUID string that represents the user ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
expirationDatestring(date-time)

Date of entitlement expiration

Example: "2022-01-01T12:00:00"
createdAtstring(date-time)required

Date when entitlement was created

Example: "2022-01-01T12:00:00"
updatedAtstring(date-time)

Date when entitlement was last updated

Example: "2022-01-01T12:00:00"
planobjectrequired
plan.​idstringrequired

UUID string that represents the plan ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
plan.​vendorIdstringrequired

UUID string that represents the vendor ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
plan.​namestringrequired

String that represents the plan name

Example: "Test Plan"
plan.​defaultTimeLimitationnumber

Number that represents the default time limitation in days for auto-assigned plans

Example: "30"
plan.​descriptionstring

Feature plan description

Example: "This is a test plan"
plan.​createdAtstringrequired

Date when plan was created

Example: "2022-01-01T00:00:00"
plan.​updatedAtstring

Date when plan was last updated

Example: "2022-01-01T00:00:00"
Response
application/json
{
  "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "planId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "tenantId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "userId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
  "expirationDate": "2022-01-01T12:00:00",
  "createdAt": "2022-01-01T12:00:00",
  "updatedAt": "2022-01-01T12:00:00",
  "plan": {
    "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "vendorId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
    "name": "Test Plan",
    "defaultTimeLimitation": "30",
    "description": "This is a test plan",
    "createdAt": "2022-01-01T00:00:00",
    "updatedAt": "2022-01-01T00:00:00"
  }
}

Feature Flags

Operations

API Access Control

Operations