Houdini 20.5 Installation And Licensing Licensing Public API

Update User Rules

Update the user rules for the given license set.

This function will either update existing rules, create new ones, or delete existing rules.

Function: cmd_up_user_rules
Version: 20.0+

Argument Name	Type	Description
user	string	The user@machine_name the request is originating from. This is used to check if the user has the required permissions to update the license set.
id	string	The id of the license set to apply the updated user rules to.
rules	array of json objects	Information for each of the rules to update, create or delete.

json rule object

{
"delete": false,
"condition": "user=='fake_user'",
"borrow": false,
"id": "",
}

Property	Type	Description
delete	boolean	Indicates the existing user rule should be deleted.
condition	string	The condition of the user rule.
borrow	boolean	The borrow property of the user rule.
id	string	The id of the user rule. If the id is missing its considered as a new user rule and it will be added. If the id is provided then an existing rule is updated. This is required when deleting user rules.

response

{
    "success": false,
    "id": "",
    "rules": [
        {
            "success": false,
            "id": "",
            "condition": "",
            "deleted": false
        }
    ]
}

Key	Type	Description
success	boolean	Indicates that the user rules were successfully applied.
id	string	The id of the license set the user rules were applied to.
rules	object	The list of user rule changes that the server tried to apply.
rules.success	boolean	True if the user rule update was successfully applied.
rules.id	string	The id of the user rule the update applied to.
rules.condition	string	The condition of the user rule.
rules.deleted	boolean	True if the user rule was deleted.

Update User Rules

Licensing Public API

Administrative ¶

Licenses ¶

Partition System ¶

Server ¶

Webhook ¶