Skip to content
Entitlements module/
/
Delete Entity Type Relati...

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

Update Entity Type Relation

Request

Modify a relation's allowed subject entity types.

Security
bearer
Bodyapplication/jsonrequired
keystringrequired
Example: "reader"
subjectEntityKeysArray of stringsrequired
Example: ["copywriter","customer"]
curl -i -X PATCH \
  'https://api.frontegg.com/entitlements/resources/entity-types/v1/{key}/relations/{relationKey}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "reader",
    "subjectEntityKeys": [
      "copywriter",
      "customer"
    ]
  }'

Responses

Bodyapplication/json
vendorIdstringread-onlyrequired
Example: "123e4567-e89b-12d3-a456-426614174000"
targetEntityTypeKeystringread-onlyrequired
Example: "book"
keystringread-onlyrequired
Example: "reader"
subjectEntityTypeKeysArray of stringsread-onlyrequired
Example: ["copywriter","customer"]
Response
application/json
{
  "vendorId": "123e4567-e89b-12d3-a456-426614174000",
  "targetEntityTypeKey": "book",
  "key": "reader",
  "subjectEntityTypeKeys": [
    "copywriter",
    "customer"
  ]
}

Delete Entity Type Relation

Request

Remove a relation definition from an entity type.

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

Responses

Get Relation Assignments

Request

List all instance-level relationship assignments.

Security
bearer
Query
offsetinteger
Default 0
limitinteger
Default 10
Example: limit=10
curl -i -X GET \
  https://api.frontegg.com/entitlements/resources/relations/v1/assignments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects(RelationAssignmentDto)read-onlyrequired
items[].​subjectEntityTypeKeystringread-onlyrequired
Example: "user"
items[].​subjectKeystringread-onlyrequired
Example: "anthony@email-of.his"
items[].​relationKeystringread-onlyrequired
Example: "reader"
items[].​targetEntityTypeKeystringread-onlyrequired
Example: "document"
items[].​targetKeystringread-onlyrequired
Example: "document-1.doc"
items[].​activeFromstring
Example: "2024-01-01T00:00:00Z"
items[].​activeUntilstring
Example: "2024-12-31T23:59:59Z"
hasNextbooleanread-onlyrequired
Example: false
Response
application/json
{
  "items": [
    { … }
  ],
  "hasNext": false
}

Features

Operations

Plans

Operations

Entitlements

Operations

Feature Flags

Operations

API Access Control

Operations