Skip to main content Skip to complementary content

License: Create a license rule for professional access

Information noteLOCKED.

This API is extremely reliable and will not be broken unless absolutely necessary.

When you create a Professional access rule, you need to create an access resource item (which is given a unique ID) and a license rule that applies to that item.

This is the sequence for creating an access group and associating a resource filter with it using the QRS API.

Create a professional access group

Method

POST

Path

/qrs/license/professionalaccessgroup

Body

body: {"name" : "The DC access group"}

Return value

Response 201

{
    	"id": "a58cd07f-3c12-4534-8b9c-12c651f80f82",
    	"createdDate": "2019-12-19T16:10:20.947Z",
    	"modifiedDate": "2019-12-19T16:10:20.947Z",
    	"modifiedByUserName": "INTERNAL\\sa_repository",
    	"name": "The DC access group",
    	"privileges": null,
    	"schemaPath": "License.ProfessionalAccessGroup"
}

Create a system rule

Create a system rule that includes the resource filter and associate it with the professional access group.

To associate the system rule with the professional access group, you need to update the resourceFilter property with the ID of the professional access group resource.

For example, "resourceFilter": "License.ProfessionalAccessGroup_a58cd07f-3c12-4534-8b9c-12c651f80f82" where “a58cd07f-3c12-4534-8b9c-12c651f80f82” is the ID of the professional access group resource.

Method

POST

Path

/qrs/systemrule

Body

{
"id": "8fbb64f5-305e-4f8b-85db-1ecbd8cb7777", "category": "License", "subcategory": "", "type": "Custom", "name": "License rule to grant professional access to specific user", "rule": "((user.userDirectory=\"INTERNAL\" and user.name=\"sa_repository\"))", "resourceFilter": "License.ProfessionalAccessGroup_a58cd07f-3c12-4534-8b9c-12c651f80f82", "actions": 15, "comment": "Rule to set up automatic professional access for user", "disabled": false, "privileges": null
}

Return value

Response 201

{
    	"id": "8fbb64f5-305e-4f8b-85db-1ecbd8cb7777",
    	"createdDate": "2019-12-19T16:18:05.585Z",
    	"modifiedDate": "2019-12-19T16:18:05.585Z",
    	"modifiedByUserName": "INTERNAL\\sa_repository",
    	"category": "License",
    	"subcategory": "",
    	"type": "Custom",
    	"name": "License rule to grant professional access to specific user",
    	"rule": "((user.userDirectory=\"INTERNAL\" and user.name=\"sa_repository\"))",
    	"resourceFilter": "License.ProfessionalAccessGroup_a58cd07f-3c12-4534-8b9c-12c651f80f82",
    	"actions": 15,
    	"comment": "Rule to set up automatic professional access for user",
    	"disabled": false,
    	"ruleContext": 0,
    	"seedId": "00000000-0000-0000-0000-000000000000",
    	"version": 0,
    	"tags": [],
    	"privileges": null,
   	"schemaPath": "SystemRule"
}

Assigning a value of 15 to the "actions" property means that the user is allowed to perform CRUD operations on a resource.

Now, when you open the QMC, you will see the new professional access group added with the resource filter.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!