Introduction

Welcome to the Entitle API portal. This is your central resource for automating configuration management at scale and embedding access requests into your applications or command-line (CLI) tools.

✅
Select your endpoint from the Base URL dropdown to test requests against that region.

Supported entities

The API allows you to manage the following entities:

Entitle tokens

Token type	Purpose	How to create a token
API token	Used for integrations or API access to read or manage Entitle data. Provides continuous, system-wide access not tied to a user.	Entitle for admins Entitle on Pathfinder
User token	Used for integrations or API access to read or manage Entitle data. Has the same permissions as the admin or user who generated it. Can be a personal access token or a CLI token.	Entitle for admins Entitle for admins on Pathfinder Entitle for users Entitle for users on Pathfinder Entitle for CLI

ℹ️
All API endpoints support both API and user tokens, except /permissions/{id}/revoke, which requires a user token (CLI or PAT).

✅
You can automate most of Entitle’s API using our Terraform Provider.