set_pool_entitlements
Add, replace, or remove user and group entitlements for Horizon desktop or application pools. Replace overwrites existing access; remove revokes it immediately.
Instructions
Add, replace, or remove entitlements for a desktop or application pool.
CAUTION: action='replace' removes any existing entitlements not in the provided list. CAUTION: action='remove' immediately revokes access for the specified principals. Always confirm with the user before using replace or remove.
NOTE: action='replace' is only supported for desktop pools — the Horizon API has no bulk-replace endpoint for application pools.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"pool_id": "<pool_id>",
"pool_type": "<pool_type>",
"action": "<action>",
"ad_user_or_group_ids": "<ad_user_or_group_ids>"
},
"name": "set_pool_entitlements"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | add: merge with existing entitlements. replace: overwrite all existing entitlements with this list. remove: revoke access for the specified users/groups. | |
| confirm | No | Only used when the server runs with HORIZON_CONFIRMATION=flag (clients without elicitation). Otherwise the user is asked to confirm directly in the client. | |
| pool_id | Yes | Pool ID to modify entitlements for | |
| pool_type | Yes | Type of pool | |
| ad_user_or_group_ids | Yes | AD user or group IDs. Use search_ad_users_or_groups to find IDs. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||