AccessEntitlement
/api/v1/entitlementsA grant of access on a TechnologyAsset to a Person or Group.
listgetcreateupdaterevokeSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| asset_id | uuid | UUID of the TechnologyAsset to which this entitlement grants access. |
| principal_id | uuid | UUID of the Person or Group that holds this entitlement. The type is determined by principalType. |
| principal_type | string | Discriminator indicating whether principalId refers to a Person or a Group. |
| entitlement_type | string | The specific permission role or access level granted. Values are asset-specific (e.g. 'admin', 'read_only', 'contributor', 'owner', 'billing_admin'). Free-form |
| granted_at | date-time | ISO 8601 timestamp when this entitlement was originally granted. |
| granted_by_id | uuid | UUID of the Person who approved or provisioned this entitlement. Null when auto-provisioned by a system without human approval. |
| expires_at | date-time | ISO 8601 timestamp when this entitlement is scheduled to expire. Null for non-expiring entitlements (not recommended for privileged access). |
| grant_source | enum | provisioned | inherited | directHow the entitlement was created. Named grant_source to avoid colliding with the envelope's provenance source field. |
| status | string | Current lifecycle status of this entitlement. 'pending_approval' entitlements are not yet active and must not be used for access decisions. |
API
client.entitlements.*Loading manifest…