Entitlements module
/
Entitlements
/
Batch update entitlements

Entitlements Overview

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/

Features

Operations

Plans

Operations

Entitlements

Operations

Batch create entitlements

Request

Create multiple entitlements in a single batch operation, efficiently associating plans with accounts (tenants) and optionally specific users.

Bodyapplication/jsonrequired
entitlementsArray of objects(CreateEntitlementDto)required

Array of entitlements to create

entitlements[].​planIdstringrequired

UUID string that represents the plan ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
entitlements[].​tenantIdstringrequired

UUID string that represents the account (tenant) ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
entitlements[].​userIdstring

UUID string that represents the user ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
entitlements[].​expirationDatestring(date-time)

Date of entitlement expiration

Example: "2022-01-01T12:00:00"
curl -i -X POST \
  https://api.frontegg.com/entitlements/resources/entitlements/v2/batch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entitlements": [
      {
        "planId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
        "tenantId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
        "userId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
        "expirationDate": "2022-01-01T12:00:00"
      }
    ]
  }'

Responses

Bodyapplication/json
entitlementIdsArray of stringsrequired

UUID string that represents the entitlement ID

Example: ["e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"]
Response
application/json
{
  "entitlementIds": [
    "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
  ]
}

Batch update entitlements

Request

Update multiple existing entitlements in a single batch operation, allowing efficient modification of expiration dates and other entitlement properties.

Bodyapplication/jsonrequired
entitlementsArray of objects(UpdateEntitlementWithIdDto)required

Array of entitlements to update

entitlements[].​expirationDatestring(date-time)

Date of entitlement expiration

Example: "2022-01-01T12:00:00"
entitlements[].​idstringrequired

UUID string that represents the entitlement ID

Example: "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
curl -i -X PATCH \
  https://api.frontegg.com/entitlements/resources/entitlements/v2/batch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entitlements": [
      {
        "expirationDate": "2022-01-01T12:00:00",
        "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3"
      }
    ]
  }'

Responses

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.

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

Feature Flags

Operations

API Access Control

Operations