Skip to content
Entitlements module/
/
Create Entity Type

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

Get Entity Types

Request

List all entity types in your schema.

Security
bearer
curl -i -X GET \
  https://api.frontegg.com/entitlements/resources/entity-types/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
hasNextbooleanread-onlyrequired
Example: true
itemsArray of objects(EntityTypeResponse)read-onlyrequired
items[].​keystringread-onlyrequired
Example: "document"
items[].​descriptionstringread-onlyrequired
Example: "Representation of a Word document file"
items[].​createdAtstring(date-time)read-onlyrequired
Example: "2021-06-02T14:00:00.000Z"
Response
application/json
{
  "hasNext": true,
  "items": [
    { … }
  ]
}

Create Entity Type

Request

Create a new entity type (e.g. document, folder, project).

Security
bearer
Bodyapplication/jsonrequired
keystringrequired
Example: "document"
descriptionstring
Example: "Representation of a Word document file"
curl -i -X POST \
  https://api.frontegg.com/entitlements/resources/entity-types/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "document",
    "description": "Representation of a Word document file"
  }'

Responses

Bodyapplication/json
keystringread-onlyrequired
Example: "document"
descriptionstringread-onlyrequired
Example: "Representation of a Word document file"
createdAtstring(date-time)read-onlyrequired
Example: "2021-06-02T14:00:00.000Z"
Response
application/json
{
  "key": "document",
  "description": "Representation of a Word document file",
  "createdAt": "2021-06-02T14:00:00.000Z"
}

Get Entity Type

Request

Retrieve an entity type along with its relations and actions.

Security
bearer
Path
keystringrequired
curl -i -X GET \
  'https://api.frontegg.com/entitlements/resources/entity-types/v1/{key}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
keystringread-onlyrequired
Example: "document"
descriptionstringread-onlyrequired
Example: "Representation of a Word document file"
createdAtstring(date-time)read-onlyrequired
Example: "2021-06-02T14:00:00.000Z"
relationsArray of stringsread-onlyrequired
actionsArray of stringsread-onlyrequired
Response
application/json
{
  "key": "document",
  "description": "Representation of a Word document file",
  "createdAt": "2021-06-02T14:00:00.000Z",
  "relations": [
    "string"
  ],
  "actions": [
    "string"
  ]
}

Features

Operations

Plans

Operations

Entitlements

Operations

Feature Flags

Operations

API Access Control

Operations