Skip to content
Entitlements module/
/
Create or replace route r...

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

Feature Flags

Operations

API Access Control

Operations

Import open API

Request

Import route configurations from an OpenAPI specification in JSON format, automatically creating routes based on the API definition.

Security
bearer
curl -i -X POST \
  https://api.frontegg.com/entitlements/resources/routes/v1/import-open-api \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Create or replace route rules

Request

Create or replace route rules for a specific route, defining access control through feature flags or permission-based restrictions that determine user authorization.

Security
bearer
Path
idstringrequired
Bodyapplication/jsonrequired
rulesArray of objects(CreateRouteRuleDto)required

Set of route rules

rules[].​typestringrequired

Rule type - can be either "feature" or "permission"

Enum"feature""permission"
Example: "feature"
rules[].​valuestringrequired

Rule value - represents a reference key to the rule type entity

Example: "my-feature-key"
curl -i -X PUT \
  'https://api.frontegg.com/entitlements/resources/routes/v1/{id}/rules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rules": [
      {
        "type": "feature",
        "value": "my-feature-key"
      }
    ]
  }'

Responses

Bodyapplication/jsonArray [
idstringread-onlyrequired
Example: "b796239c-6641-4cf3-9ff3-658ad4049131"
routeIdstringread-onlyrequired
Example: "b796239c-6641-4cf3-9ff3-658ad4049131"
typestringread-onlyrequired
Enum"feature""permission"
Example: "feature"
valuestringread-onlyrequired
Example: "my-feature-key"
]
Response
application/json
[
  {
    "id": "b796239c-6641-4cf3-9ff3-658ad4049131",
    "routeId": "b796239c-6641-4cf3-9ff3-658ad4049131",
    "type": "feature",
    "value": "my-feature-key"
  }
]