Create a new Entitlement.
Entitlement object. Use the type field to specify the entitlement type (Network, BrokeredRdp, BrokeredSsh).
An Entitlement of any type. The shape of the object depends on the type field. Use the type discriminator to determine which fields are present.
ID of the object.
Name of the object.
Notes for the object. Used for documentation purposes.
Array of tags.
The type of the Entitlement.
If true, the Entitlement will be disregarded during authorization.
ID of the Site for this Entitlement.
Whether all the Conditions must succeed to have access to this Entitlement or just one.
List of Condition IDs applied to this Entitlement.
List of all IP Access actions in this Entitlement.
IP Access action.
Type of the IP Access action. Required unless the action is exclude.
Applied action to the traffic.
Hosts to apply the action to. See admin manual for possible values.
Destination port. Multiple ports can be entered comma separated. Port ranges can be entered dash separated. Only valid for tcp, udp, ssh, and rdp subtypes
ICMP type. Only valid for icmp subtypes.
HTTP method. Only valid for http subtypes. Leave it empty to allow all types.
Only available for tcp_up and http_up subtypes. If enabled, Gateways will monitor this action for responsiveness and act accordingly. See admin manual for more details.
Number of seconds the action needs to be unresponsive to mark the action unhealthy.
Hosts exempt from Entitlement Optimization analysis. Traffic to these hosts will not be considered when calculating the optimization score for this action. Uses the same format as hosts.
Destination ports exempt from Entitlement Optimization analysis. Traffic on these ports will not be considered when calculating the optimization score for this action. Only valid for tcp, udp, ssh, and rdp subtypes. Uses the same format as ports.
ICMP types exempt from Entitlement Optimization analysis. Traffic of these types will not be considered when calculating the optimization score for this action. Only valid for icmp subtypes. Uses the same format as types.
HTTP methods exempt from Entitlement Optimization analysis. Traffic using these methods will not be considered when calculating the optimization score for this action. Only valid for http subtypes.
Array of App Shortcuts.
Publishes the configured URL as an app on the client using the display name as the app name.
Name for the App Shortcut which will be visible on the Client UI.
Description for the App Shortcut which will be visible on the Client UI.
The URL that will be triggered on the OS to be handled. For example, an HTTPS URL will start the browser for the given URL.
The color code of the shortcut on the client.
- 1: Light Green
- 2: Green
- 3: Indigo
- 4: Deep Purple
- 5: Yellow
- 6: Lime
- 7: Light Blue
- 8: Blue
- 9: Amber
- 10: Orange
- 11: Cyan
- 12: Teal
- 13: Deep Orange
- 14: Red
- 15: Gray
- 16: Brown
- 17: Pink
- 18: Purple
- 19: Blue Gray
- 20: Near Black
The group name this shortcut is to be grouped by
List of Entitlement Script IDs used for creating App Shortcuts dynamically.
ID of the object.
Name of the object.
Notes for the object. Used for documentation purposes.
Array of tags.
The type of the Entitlement.
If true, the Entitlement will be disregarded during authorization.
ID of the Site for this Entitlement.
Whether all the Conditions must succeed to have access to this Entitlement or just one.
List of Condition IDs applied to this Entitlement.
Hostname or IP address of the target host.
Port number of the target host.
Whether sessions to this entitlement are recorded.
Whether sessions to this entitlement can be monitored live.
Optional message shown to the user before the session starts. When set, the client requires the user to accept it before connecting.
Name of the Credentials secret used for injection at session establishment. The secret must be of the Credentials or SSH Key type.
Shortcut configuration for the brokered session, displayed to the user in the client.
Name for the shortcut which will be visible on the Client UI.
Description for the shortcut which will be visible on the Client UI.
Group name this shortcut is to be grouped by in the client.
The color code of the shortcut on the client.
- 1: Light Green
- 2: Green
- 3: Indigo
- 4: Deep Purple
- 5: Yellow
- 6: Lime
- 7: Light Blue
- 8: Blue
- 9: Amber
- 10: Orange
- 11: Cyan
- 12: Teal
- 13: Deep Orange
- 14: Red
- 15: Gray
- 16: Brown
- 17: Pink
- 18: Purple
- 19: Blue Gray
- 20: Near Black
Whether clipboard sharing between Client and remote host is permitted for this Entitlement.
Whether file transfers between Client and remote host are permitted for this Entitlement.
Idle-session timeout in minutes. The session is terminated after this many minutes without user activity.
Whether this Entitlement's host is exempt from Entitlement Optimization analysis. When true, traffic to the host is not considered when calculating the optimization score.
Whether this Entitlement's port is exempt from Entitlement Optimization analysis. When true, traffic on the port is not considered when calculating the optimization score.
Screen resolution to negotiate with the RDP server for the session.
Color depth, in bits per pixel, to negotiate with the RDP server for the session.
Keyboard layout advertised to the RDP server. If omitted, the server's default layout is used.
Optional Windows domain to use when authenticating against the RDP server. If omitted, no domain is sent.
RDP security protocol to negotiate with the target host. nla (Network Level Authentication) is preferred; any lets the server pick.
Whether audio redirection from the remote host to the Client is permitted for this Entitlement.
ID of the object.
Name of the object.
Notes for the object. Used for documentation purposes.
Array of tags.
The type of the Entitlement.
If true, the Entitlement will be disregarded during authorization.
ID of the Site for this Entitlement.
Whether all the Conditions must succeed to have access to this Entitlement or just one.
List of Condition IDs applied to this Entitlement.
Hostname or IP address of the target host.
Port number of the target host.
Whether sessions to this entitlement are recorded.
Whether sessions to this entitlement can be monitored live.
Optional message shown to the user before the session starts. When set, the client requires the user to accept it before connecting.
Name of the Credentials secret used for injection at session establishment. The secret must be of the Credentials or SSH Key type.
Shortcut configuration for the brokered session, displayed to the user in the client.
Name for the shortcut which will be visible on the Client UI.
Description for the shortcut which will be visible on the Client UI.
Group name this shortcut is to be grouped by in the client.
The color code of the shortcut on the client.
- 1: Light Green
- 2: Green
- 3: Indigo
- 4: Deep Purple
- 5: Yellow
- 6: Lime
- 7: Light Blue
- 8: Blue
- 9: Amber
- 10: Orange
- 11: Cyan
- 12: Teal
- 13: Deep Orange
- 14: Red
- 15: Gray
- 16: Brown
- 17: Pink
- 18: Purple
- 19: Blue Gray
- 20: Near Black
Whether clipboard sharing between Client and remote host is permitted for this Entitlement.
Whether file transfers between Client and remote host are permitted for this Entitlement.
Idle-session timeout in minutes. The session is terminated after this many minutes without user activity.
Whether this Entitlement's host is exempt from Entitlement Optimization analysis. When true, traffic to the host is not considered when calculating the optimization score.
Whether this Entitlement's port is exempt from Entitlement Optimization analysis. When true, traffic on the port is not considered when calculating the optimization score.
Terminal type advertised to the SSH server for the session (TERM environment variable).
Interval, in seconds, between SSH keep-alive messages sent to the target host. Must be 0 (disabled) or between 2 and 30.
Host key verification policy applied when establishing the SSH session. OFF disables verification, TOFU (trust-on-first-use) records the host key on first connection and enforces it thereafter, ENFORCED requires a pre-known host key. The Gateway does not verify host keys yet; the policy takes effect in a later release.
Created Entitlement.
An Entitlement of any type. The shape of the object depends on the type field. Use the type discriminator to determine which fields are present.
ID of the object.
Name of the object.
Notes for the object. Used for documentation purposes.
Create date.
Last update date.
Whether the entity is protected from manual updates and deletes.
Array of tags.
The type of the Entitlement.
If true, the Entitlement will be disregarded during authorization.
ID of the Site for this Entitlement.
Name of the Site for this Entitlement. For convenience only.
Whether all the Conditions must succeed to have access to this Entitlement or just one.
List of Condition IDs applied to this Entitlement.
Indicates how optimized this Entitlement is based on usage data. Actions or hosts/ports/types/methods marked as optimizationExempt are excluded from this calculation. Licensed feature.
Numeric percentage score representing how optimized this Entitlement is based on usage data. Licensed feature.
List of all IP Access actions in this Entitlement.
IP Access action.
Type of the IP Access action. Required unless the action is exclude.
Applied action to the traffic.
Hosts to apply the action to. See admin manual for possible values.
Destination port. Multiple ports can be entered comma separated. Port ranges can be entered dash separated. Only valid for tcp, udp, ssh, and rdp subtypes
ICMP type. Only valid for icmp subtypes.
HTTP method. Only valid for http subtypes. Leave it empty to allow all types.
Only available for tcp_up and http_up subtypes. If enabled, Gateways will monitor this action for responsiveness and act accordingly. See admin manual for more details.
Number of seconds the action needs to be unresponsive to mark the action unhealthy.
Hosts exempt from Entitlement Optimization analysis. Traffic to these hosts will not be considered when calculating the optimization score for this action. Uses the same format as hosts.
Destination ports exempt from Entitlement Optimization analysis. Traffic on these ports will not be considered when calculating the optimization score for this action. Only valid for tcp, udp, ssh, and rdp subtypes. Uses the same format as ports.
ICMP types exempt from Entitlement Optimization analysis. Traffic of these types will not be considered when calculating the optimization score for this action. Only valid for icmp subtypes. Uses the same format as types.
HTTP methods exempt from Entitlement Optimization analysis. Traffic using these methods will not be considered when calculating the optimization score for this action. Only valid for http subtypes.
Array of App Shortcuts.
Publishes the configured URL as an app on the client using the display name as the app name.
Name for the App Shortcut which will be visible on the Client UI.
Description for the App Shortcut which will be visible on the Client UI.
The URL that will be triggered on the OS to be handled. For example, an HTTPS URL will start the browser for the given URL.
The color code of the shortcut on the client.
- 1: Light Green
- 2: Green
- 3: Indigo
- 4: Deep Purple
- 5: Yellow
- 6: Lime
- 7: Light Blue
- 8: Blue
- 9: Amber
- 10: Orange
- 11: Cyan
- 12: Teal
- 13: Deep Orange
- 14: Red
- 15: Gray
- 16: Brown
- 17: Pink
- 18: Purple
- 19: Blue Gray
- 20: Near Black
The group name this shortcut is to be grouped by
List of Entitlement Script IDs used for creating App Shortcuts dynamically.
ID of the object.
Name of the object.
Notes for the object. Used for documentation purposes.
Create date.
Last update date.
Whether the entity is protected from manual updates and deletes.
Array of tags.
The type of the Entitlement.
If true, the Entitlement will be disregarded during authorization.
ID of the Site for this Entitlement.
Name of the Site for this Entitlement. For convenience only.
Whether all the Conditions must succeed to have access to this Entitlement or just one.
List of Condition IDs applied to this Entitlement.
Indicates how optimized this Entitlement is based on usage data. Actions or hosts/ports/types/methods marked as optimizationExempt are excluded from this calculation. Licensed feature.
Numeric percentage score representing how optimized this Entitlement is based on usage data. Licensed feature.
Hostname or IP address of the target host.
Port number of the target host.
Whether sessions to this entitlement are recorded.
Whether sessions to this entitlement can be monitored live.
Optional message shown to the user before the session starts. When set, the client requires the user to accept it before connecting.
Name of the Credentials secret used for injection at session establishment. The secret must be of the Credentials or SSH Key type.
Shortcut configuration for the brokered session, displayed to the user in the client.
Name for the shortcut which will be visible on the Client UI.
Description for the shortcut which will be visible on the Client UI.
Group name this shortcut is to be grouped by in the client.
The color code of the shortcut on the client.
- 1: Light Green
- 2: Green
- 3: Indigo
- 4: Deep Purple
- 5: Yellow
- 6: Lime
- 7: Light Blue
- 8: Blue
- 9: Amber
- 10: Orange
- 11: Cyan
- 12: Teal
- 13: Deep Orange
- 14: Red
- 15: Gray
- 16: Brown
- 17: Pink
- 18: Purple
- 19: Blue Gray
- 20: Near Black
Whether clipboard sharing between Client and remote host is permitted for this Entitlement.
Whether file transfers between Client and remote host are permitted for this Entitlement.
Idle-session timeout in minutes. The session is terminated after this many minutes without user activity.
Whether this Entitlement's host is exempt from Entitlement Optimization analysis. When true, traffic to the host is not considered when calculating the optimization score.
Whether this Entitlement's port is exempt from Entitlement Optimization analysis. When true, traffic on the port is not considered when calculating the optimization score.
Screen resolution to negotiate with the RDP server for the session.
Color depth, in bits per pixel, to negotiate with the RDP server for the session.
Keyboard layout advertised to the RDP server. If omitted, the server's default layout is used.
Optional Windows domain to use when authenticating against the RDP server. If omitted, no domain is sent.
RDP security protocol to negotiate with the target host. nla (Network Level Authentication) is preferred; any lets the server pick.
Whether audio redirection from the remote host to the Client is permitted for this Entitlement.
ID of the object.
Name of the object.
Notes for the object. Used for documentation purposes.
Create date.
Last update date.
Whether the entity is protected from manual updates and deletes.
Array of tags.
The type of the Entitlement.
If true, the Entitlement will be disregarded during authorization.
ID of the Site for this Entitlement.
Name of the Site for this Entitlement. For convenience only.
Whether all the Conditions must succeed to have access to this Entitlement or just one.
List of Condition IDs applied to this Entitlement.
Indicates how optimized this Entitlement is based on usage data. Actions or hosts/ports/types/methods marked as optimizationExempt are excluded from this calculation. Licensed feature.
Numeric percentage score representing how optimized this Entitlement is based on usage data. Licensed feature.
Hostname or IP address of the target host.
Port number of the target host.
Whether sessions to this entitlement are recorded.
Whether sessions to this entitlement can be monitored live.
Optional message shown to the user before the session starts. When set, the client requires the user to accept it before connecting.
Name of the Credentials secret used for injection at session establishment. The secret must be of the Credentials or SSH Key type.
Shortcut configuration for the brokered session, displayed to the user in the client.
Name for the shortcut which will be visible on the Client UI.
Description for the shortcut which will be visible on the Client UI.
Group name this shortcut is to be grouped by in the client.
The color code of the shortcut on the client.
- 1: Light Green
- 2: Green
- 3: Indigo
- 4: Deep Purple
- 5: Yellow
- 6: Lime
- 7: Light Blue
- 8: Blue
- 9: Amber
- 10: Orange
- 11: Cyan
- 12: Teal
- 13: Deep Orange
- 14: Red
- 15: Gray
- 16: Brown
- 17: Pink
- 18: Purple
- 19: Blue Gray
- 20: Near Black
Whether clipboard sharing between Client and remote host is permitted for this Entitlement.
Whether file transfers between Client and remote host are permitted for this Entitlement.
Idle-session timeout in minutes. The session is terminated after this many minutes without user activity.
Whether this Entitlement's host is exempt from Entitlement Optimization analysis. When true, traffic to the host is not considered when calculating the optimization score.
Whether this Entitlement's port is exempt from Entitlement Optimization analysis. When true, traffic on the port is not considered when calculating the optimization score.
Terminal type advertised to the SSH server for the session (TERM environment variable).
Interval, in seconds, between SSH keep-alive messages sent to the target host. Must be 0 (disabled) or between 2 and 30.
Host key verification policy applied when establishing the SSH session. OFF disables verification, TOFU (trust-on-first-use) records the host key on first connection and enforces it thereafter, ENFORCED requires a pre-known host key. The Gateway does not verify host keys yet; the policy takes effect in a later release.
JSON error. Check the JSON format.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Token error. Login again.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Insufficient license.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Insufficient permissions to access this resource.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Invalid 'Accept' header.
Generic HTTP error.
Machine readable error code.
Human readable error details.
The submitted resource conflicts with another.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Request validation error. Check "errors" array for details.
Http 422 error for object validation.
Machine readable error code.
Human readable error details.
List of fields with validation errors.
Name of the field that failed validation.
Failure reason.
Name of the field that should be displayed in the UI. It's an internal field to be used by the local replication service.
Message to be displayed in the replication UI. It's an internal field to be used by the local replication service.
Unexpected server side error.
Generic HTTP error.
Machine readable error code.
Human readable error details.