Entitlement Service REST API

The Entitlement Service REST API handles write operations such as allocation updates and bulk imports. For read-heavy screens (product lists, entitlement summaries, activity logs), use the GraphQL API.

Local Endpoints

Endpoint	Method	Description
/healthz	GET	Health check
/organizations/{organizationId}/products/{productId}/allocations	PUT	Update manual seat allocations for a product
/organizations/{organizationId}/bulk-import-jobs	POST/GET	Create and list bulk import jobs
/bulk-import-jobs/{jobId}/artifacts.zip	GET	Download import artifacts (results, error reports)
/graphql	POST	GraphQL endpoint (see GraphQL API docs)

Base URL: http://127.0.0.1:4317

Allocation Update Example

await fetch(
  'http://127.0.0.1:4317/organizations/org-demo-001/products/prod-insight-studio/allocations',
  {
    method: 'PUT',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      selectedUserIds: ['user-tenant-admin', 'user-tenant-member'],
    }),
  }
);

The request replaces the current manual allocation for that product — it is not additive. The selectedUserIds should use IDs from the productUserAccess GraphQL query. After a successful update, refresh the entitlement summary, allocated users list, and activity log.

Full API Reference

• Redoc reference page — static generated reference documentation