Qt License Server ACL file format

For on-premises Qt License Server, create an access control list (ACL) file in JSON format (acl.json) to enable access control rules per license and per user.

Note: To use ACLs, enable access control with QLS_ACCESS_CONTROL=yes in the Qt License Server configuration file and then restart Qt License Server.

Possible data

The objects in the ACL file can contain the following data.

Name	Possible values	Description
licenseNumber	License number from Qt	The `entitlement.json` file lists license numbers.
effect	`Allowed` `Denied`	Allow or deny license use for the user.
users	username or email address, depending on Qt License Server configuration * indicates all users	User IDs separated by commas.

accessControl object

An accessControl object contains one licenses object. Each license record contains a license number and a list of users who can or cannot reserve the license, depending on the value of effect.

{
    "accessControl": {
        "licenses": [
            {
                "licenseNumber": "<number>",
                "effect": "Allowed" | "Denied",
                "users": [ "<username>" | "<email>" | "*" ],
            }
        ]
    }
}

longtermUsage object

A longtermUsage object contains one licenses object. Each license record contains a license number and a list of users who can reserve the license until its expiration date.

{
    "longtermUsage": {
        "licenses": [
            {
                "licenseNumber": "<number>",
                "users": [ "<username>" | "<email>" | "*" ],
            }
        ]
    }
}

Example ACL JSON file

The following example ACL file specifies the usernames of two users who can use one license and another two users who can use another license. Also, two users can use a third license until its expiration date.

{
    "accessControl": {
        "licenses": [
            {
                "licenseNumber": "11111111",
                "effect": "Allowed",
                "users": [
                    "a_user",
                    "b_user"
                ]
            },
            {
                "licenseNumber": "22222222",
                "effect": "Allowed",
                "users": [
                    "c_user",
                    "d_user"
                ]
            }
        ]
    },
    "longtermUsage": {
        "licenses": [
            {
                "licenseNumber": "33333333",
                "users": [
                    "a_user",
                    "b_user"
                ]
            }
        ]
    }
}

See also Manage access control lists.

Reference License properties

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.