post https://iris.trackunit.com/api/access-management/keys
The "Create Key" endpoint generates a single access key for various access methods and target scopes, allowing you to define a time period during which the key is active.
This key is used to secure and control access to assets within the system.
Access keys can be created for individual operators, asset groups, entire sites, or entire fleets of assets, with the option to specify an active time window for the key.
May return constraint violations if access requests:
- Break mandatory business rules.
- Reference non-existent objects.
| Code | Type | Description |
|---|---|---|
assetsNotFound | Unknown object | [assetId] not found. |
operatorsNotFound | Unknown object | [operatorId] not found. |
groupsNotFound | Unknown object | [groupId] not found. |
sitesNotFound | Unknown object | [siteId] not found. |
accountOperatorKeysNotAllowed | Business rule violation | [operatorId] cannot be assigned digital keys or rolling PINs due to account restrictions. |
conflictingKey | Business rule violation | Existing key with overlapping time, same asset/group/site/fleet, and identical key card or static PIN. |
conflictType | Business rule violation | "non-customer specific access already exists" – generic non-customer key blocks specific customer key. "similar access already exists" – similar key already exists. |
OpenAPI Specification for the Access Management API domain
Get the OpenAPI Specification (formerly Swagger), which is a standardized format that describes the functionalities, endpoints, parameters, and data models of this API in a JSON file here.