Playground

Playground

LicenseAssignment

/api/v1/licenses/assignments

A seat assignment of a SoftwareLicense to a Person or Group.

listgetcreaterevoke

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp 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-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
license_iduuidUUID of the SoftwareLicense from which this seat is assigned.
assignee_iduuidUUID of the Person or Group to whom this license seat is assigned. The type is determined by assigneeType.
assignee_typestringDiscriminator indicating whether assigneeId refers to a Person or a Group.
asset_iduuidUUID of the TechnologyAsset for which this license is being used, if different from or more specific than the license's top-level assetId. Allows tracking which
assigned_atdate-timeISO 8601 timestamp when this license seat was assigned.
assigned_by_iduuidUUID of the Person who performed or approved this assignment.
expires_atdate-timeISO 8601 timestamp when this assignment is scheduled to expire. Null for indefinite assignments.
statusstringCurrent lifecycle status of this assignment.
last_used_atdate-timeISO 8601 timestamp when the assigned seat was last actively used by the assignee. Null if usage has never been recorded.

API

client.licenses.*
Loading manifest…