---
title: "Entitlement Scripts"
slug: "configure-entitlement-scripts-v6-7"
description: "Create or edit Entitlement scripts that define the app shortcuts and related host or port Entitlement actions. You can also clone or test a script in this page."
tags: ["Client App Shortcuts", "Entitlement scripts", "Entitlements"]
updated: 2026-03-19T20:29:06Z
published: 2026-04-03T16:41:09Z
canonical: "support.appgate.com/configure-entitlement-scripts-v6-7"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.appgate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Entitlement Scripts

Entitlement scripts are used to define the app shortcuts and related actions in an entitlement. The three types are:

- ***App Shortcut***. Defines the name, description, URL, and icon color for the app shortcut that will be displayed in the client.
- ***Host***. Defines a resolvable name or IP address. If resource names are returned, then later the name resolver will resolve these to IP addresses.
- ***Port or Type***. Defines one or more port numbers or ICMP types.

## Before you start

Background reading:

- See the [Use of scripts](/v1/docs/use-of-scripts-v6-7) section for more considerations and information.
- If using host scripts, ensure the [Site is configured](/v1/docs/configure-site-v6-7) to resolve the syntax that the script will generate.
- Get a better understanding of [defining hosts](/v1/docs/defining-hosts-v6-7), including how and why you would use these scripts.

## Configuring entitlement scripts

To configure a script, in the **Entitlement Scripts** page, select **+Add** and select the type of script. Then complete the following fields:

- ***Name.*** Enter a name with only lowercase alphanumeric characters with underscore or dash. When creating actions in entitlements, the script(s) for host and port will be referred to with the syntax script://<name>.

> [!NOTE]
> **NOTE**
> 
> If you are editing an existing script, changing the name may break existing entitlements.

- ***Notes***. Optional. Enter any notes for the script.
- ***Tags***. Click **+Add** to add tags to the script.
- ***Expression.*** An example expression is provided - typically the script should return same information used when creating an entitlement manually.

### Entitlement script actions

While in the **Add or Edit Entitlement Script** page, use the **Actions** button to perform the following actions:

- ***Clone.*** Clone the entitlement script.
- ***Test.*** Tests the script. Opens the **Test Expression** window. From here you can enter values to simulate claims or switch to active session mode and use an active session to test the claims.