License Enforcement

EMS v4 acts as the source of truth for Trimble User (or Device) license assignments. Trimble products will be consuming this data to perform license enforcement within their product or system boundaries.

License enforcement within Trimble products involves two steps:

1. To retrieve licensing information for TID users or devices from EMS v4, an authenticated call needs to be made with TID access_token which can be an application or user token.
2. In EMS v4, when you execute a GET request with that access token, a paginated list of licenses will be returned for the Trimble users, devices, that are specified in the request. Trimble products will make use of the licenses that were returned to authorize access to their features.

The /entitlements/licenses endpoints support many combinations of query parameters and TID identity types. The most requested pattern filters licenses using the following fields:

• Entitlement ID
• SKU
• Holder ID
• License ID

Note

GET /entitlements/licenses?holderId=b0d14d7a-d990-40cf-8bd2-ea559763db0c&accountId=1093038874905&status=active

{
    "items": [
        {
        "id": "4fe617d0-3312-4c82-8a8a-1122f8348095",
        "holderId": "b0d14d7a-d990-40cf-8bd2-ea559763db0c",
        "memberSince": "2025-04-25T09:23:37Z",
        "activationDate": "2023-10-24T10:21:21Z",
        "deactivationDate": "2024-10-24T10:21:21Z",
        "status": "active",
        "sku": {
            "id": "TC-01-BUSS-PREM",
            "type": "bundle",
            "children": [
            {
                "id": "SKP-PRO-YR-01",
                "type": "product",
                "rank": 0,
                "customAttribute": null,
                "features": [
                {
                    "featureId": "FEA-PROJ-USERS",
                    "usage": {
                    "max": 10,
                    "metric": "GB",
                    "totalUsed": 2,
                    "activities": [
                        {
                        "customAttribute": "{\"deviceId\": \"deviceId3qjaadv\", \"deviceName\": \"1\", \"userId\": \"2226991ss060\", \"authorizedAt\": \"2023-12-24T10:21:21Z\"}",
                        "used": 1
                        },
                        {
                        "customAttribute": "{\"deviceId\": \"deviceId3qjaadv11\", \"deviceName\": \"2\", \"userId\": \"2226991ss0601\", \"authorizedAt\": \"2023-12-24T10:21:21Z\"}",
                        "used": 2
                        }
                    ]
                    }
                },
                {
                    "featureId": "FEA-CON-PREMIUM",
                    "usage": {
                    "max": 10,
                    "metric": "GB",
                    "totalUsed": 0,
                    "activities": []
                    }
                },
                {
                    "featureId": "SUB-EST-USAGE-MAX",
                    "usage": null
                }
                ]
            }
            ]
        },
        "entitlement": {
            "id": "1a053e53-3adc-4b0b-8002-4a1b593d1370",
            "version": 1
        },
        "accountId": "1093038874905",
        "customAttribute": "{ name = Bruce Wayne, city = Gotham }",
        "checkOutDate": "2024-06-24T10:29:30Z",
        "checkInDate": "2024-06-29T10:29:30Z",
        "isCheckedOut": true,
        "revokeAtCheckIn": true,
        "dealerAccounts": [
            {
            "dealerAccountId": "dealer_1",
            "dealerType": "partner"
            },
            {
            "dealerAccountId": "dealer_2",
            "dealerType": "reseller"
            }
        ],
        "emsSource": "emsv4",
        "subscriptionModel": "seat-based",
        "isNonTransferable": false
        },
        {
        "id": "eee71d21-41ce-4d40-8408-6328ff68cb6c",
        "holderId": "3ef7e150-a3e4-4b7b-96e7-07f4843e0dbd",
        "memberSince": "2023-10-24T10:21:21Z",
        "activationDate": "2023-10-24T10:21:21Z",
        "deactivationDate": "2024-10-24T10:21:21Z",
        "status": "active",
        "sku": {
            "id": "SUB-EST-CON-FREE-D",
            "type": "product",
            "rank": 0,
            "customAttribute": null,
            "features": [
            {
                "featureId": "FEA-PROJ-USERS",
                "usage": {
                "max": 10,
                "metric": "GB",
                "totalUsed": 1,
                "activities": [
                    {
                    "customAttribute": "{\"deviceId\": \"deviceId3qjaadv\", \"deviceName\": \"1\", \"userId\": \"2226991ss060\", \"authorizedAt\": \"2023-12-24T10:21:21Z\"}",
                    "used": 1
                    }
                ]
                }
            }
            ]
        },
        "entitlement": {
            "id": "1a053e53-3adc-4b0b-8002-4a1b593d1370",
            "version": 1
        },
        "accountId": "1093038874905",
        "customAttribute": "{ name = Bruce Wayne, city = Gotham }",
        "checkOutDate": "2024-06-24T10:29:30Z",
        "checkInDate": "2024-06-29T10:29:30Z",
        "isCheckedOut": true,
        "revokeAtCheckIn": true,
        "dealerAccounts": [
            {
            "dealerAccountId": "dealer_1",
            "dealerType": "partner"
            },
            {
            "dealerAccountId": "dealer_2",
            "dealerType": "reseller"
            }
        ],
        "emsSource": "emsv4",
        "isNonTransferable": false
        }
    ],
    "nextPageKey": null
}