List all Entitlements

Prev Next
Get
/entitlements

List all Entitlements visible to current user.

Security
HTTP
Type bearer
Query parameters
query
string

Query string to filter the result list. It's used for various fields depending on the object type. Send multiple query parameters to make the queries more specific.

range
string

'Range string to limit the result list. Format: -. 3-10 means the items between the (including) 3rd and the 10th will be returned. Defaults to all objects.'

Example0-10
orderBy
string

The field name to sort the result list. Supported fields vary from object to object. Defaults to certain field depending on the object type.

Examplename
descending
string

Whether the sorting is applied descending or ascending. Defaults to certain field depending on the object type.

filterBy

Filters the result list by the given field and value. Supported fields vary from API to API. The filters can be combined with each other as well as the generic query parameter. The given value is checked for inclusion.

object
property*
string additionalProperties
Example{ "name": "us-east", "tags": "aws" }
Responses
200

List of Entitlements.

Expand All
object
range
string

The range applied to the list. Format: -/. 3-5/8 means, out of 8 count (query affects the total), the items between (including) the 3rd and the 5th are returned.

Example0-30/54
orderBy
string

The field name used to sort the list.

Examplename
descending
boolean

Whether the sorting is applied descending or ascending.

queries
Array of string

The queries applied to the list.

string
totalCount
integer

The total readable count of entities. Not influenced by the query.

Example328
filterBy
Array of object (FilterBy)

The filters applied to the list.

object
name
string

The field name the filter is applied to.

Examplename
value
string

The value used for comparison.

ExampleAWS
data
Array of object (AnyEntitlement)

List of Entitlements.

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.

OneOf
Entitlement
object (Entitlement)
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
created
string (date-time)

Create date.

updated
string (date-time)

Last update date.

readOnly
boolean

Whether the entity is protected from manual updates and deletes.

Examplefalse
tags
Array of string

Array of tags.

Example[ "developer", "api-created" ]
string
type
string

The type of the Entitlement.

Valid values[ "Network", "BrokeredRdp", "BrokeredSsh" ]
Default"Network"
ExampleNetwork
disabled
boolean

If true, the Entitlement will be disregarded during authorization.

Defaultfalse
site
string (uuid)

ID of the Site for this Entitlement.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
siteName
string

Name of the Site for this Entitlement. For convenience only.

ExampleDefault Site
conditionLogic
string

Whether all the Conditions must succeed to have access to this Entitlement or just one.

Valid values[ "and", "or" ]
Default"and"
conditions
Array of string

List of Condition IDs applied to this Entitlement.

Min items1
string (uuid)
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
optimizationScore
string

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.

Valid values[ "NotLinked", "Unused", "Overprovisioned", "InsufficientData", "NotInUse", "NotAnalyzed", "OptimizedWithExemptions", "Optimized" ]
Default"InsufficientData"
optimizationScorePercentage
integer

Numeric percentage score representing how optimized this Entitlement is based on usage data. Licensed feature.

actions
Array of object

List of all IP Access actions in this Entitlement.

object

IP Access action.

subtype
string

Type of the IP Access action. Required unless the action is exclude.

Valid values[ "icmp_up", "icmp_down", "icmpv6_up", "icmpv6_down", "udp_up", "udp_down", "tcp_up", "tcp_down", "ah_up", "ah_down", "esp_up", "esp_down", "gre_up", "gre_down", "http_up" ]
action
string

Applied action to the traffic.

Valid values[ "allow", "block", "alert", "exclude" ]
hosts
Array of string

Hosts to apply the action to. See admin manual for possible values.

Example[ "10.0.0.1", "10.0.0.0/24", "hostname.company.com", "dns://hostname.company.com", "aws://security-group:accounting" ]
string
ports
Array of string

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

Example[ 80, "1024-65535" ]
string
types
Array of string

ICMP type. Only valid for icmp subtypes.

Example[ "0-255" ]
string
methods
Array of string (HttpMethod)

HTTP method. Only valid for http subtypes. Leave it empty to allow all types.

string
Valid values[ "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH", "MKCOL", "COPY", "MOVE", "PROPFIND", "PROPPATCH", "LOCK", "UNLOCK" ]
monitor
object

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.

enabled
boolean
Defaultfalse
timeout
integer

Number of seconds the action needs to be unresponsive to mark the action unhealthy.

Default30
optimizationExemptHosts
Array of string

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.

Example[ "10.0.0.1", "hostname.company.com" ]
string
optimizationExemptPorts
Array of string

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.

Example[ 8080, "9000-9100" ]
string
optimizationExemptTypes
Array of string

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.

Example[ "0-255" ]
string
optimizationExemptMethods
Array of string (HttpMethod)

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.

string
Valid values[ "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH", "MKCOL", "COPY", "MOVE", "PROPFIND", "PROPPATCH", "LOCK", "UNLOCK" ]
appShortcuts
Array of object (AppShortcut)

Array of App Shortcuts.

object

Publishes the configured URL as an app on the client using the display name as the app name.

name
string

Name for the App Shortcut which will be visible on the Client UI.

ExampleAccounting Software
description
string

Description for the App Shortcut which will be visible on the Client UI.

ExampleThis app will get you to the Accounting Software.
url
string

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.

Examplehttps://service.company.com
colorCode
integer

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
Minimum1
Maximum20
Default1
groupName
string

The group name this shortcut is to be grouped by

ExampleAccounting Applications
appShortcutScripts
Array of string

List of Entitlement Script IDs used for creating App Shortcuts dynamically.

string (uuid)
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
BrokeredRdpEntitlement
object (BrokeredRdpEntitlement)
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
created
string (date-time)

Create date.

updated
string (date-time)

Last update date.

readOnly
boolean

Whether the entity is protected from manual updates and deletes.

Examplefalse
tags
Array of string

Array of tags.

Example[ "developer", "api-created" ]
string
type
string

The type of the Entitlement.

Valid values[ "Network", "BrokeredRdp", "BrokeredSsh" ]
Default"Network"
ExampleNetwork
disabled
boolean

If true, the Entitlement will be disregarded during authorization.

Defaultfalse
site
string (uuid)

ID of the Site for this Entitlement.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
siteName
string

Name of the Site for this Entitlement. For convenience only.

ExampleDefault Site
conditionLogic
string

Whether all the Conditions must succeed to have access to this Entitlement or just one.

Valid values[ "and", "or" ]
Default"and"
conditions
Array of string

List of Condition IDs applied to this Entitlement.

Min items1
string (uuid)
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
optimizationScore
string

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.

Valid values[ "NotLinked", "Unused", "Overprovisioned", "InsufficientData", "NotInUse", "NotAnalyzed", "OptimizedWithExemptions", "Optimized" ]
Default"InsufficientData"
optimizationScorePercentage
integer

Numeric percentage score representing how optimized this Entitlement is based on usage data. Licensed feature.

host
string

Hostname or IP address of the target host.

Example192.34.220.15
port
integer

Port number of the target host.

Minimum1
Maximum65535
Example3389
recordingEnabled
boolean

Whether sessions to this entitlement are recorded.

Defaultfalse
monitoringEnabled
boolean

Whether sessions to this entitlement can be monitored live.

Defaultfalse
disclosureMessage
string

Optional message shown to the user before the session starts. When set, the client requires the user to accept it before connecting.

credentialsName
string

Name of the Credentials secret used for injection at session establishment. The secret must be of the Credentials or SSH Key type.

ExampleRDP_SERVICE_ACCOUNT
appShortcut
object (BrokeredShortcut)

Shortcut configuration for the brokered session, displayed to the user in the client.

name
string

Name for the shortcut which will be visible on the Client UI.

ExampleWin desktop u3543
description
string

Description for the shortcut which will be visible on the Client UI.

Default""
ExampleThis is information that will appear in the client, for the user to read.
groupName
string

Group name this shortcut is to be grouped by in the client.

ExampleRemote Desktops
colorCode
integer

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
Minimum1
Maximum20
Default1
clipboardSharing
boolean

Whether clipboard sharing between Client and remote host is permitted for this Entitlement.

Defaultfalse
fileTransfer
boolean

Whether file transfers between Client and remote host are permitted for this Entitlement.

Defaultfalse
idleTimeoutMinutes
integer

Idle-session timeout in minutes. The session is terminated after this many minutes without user activity.

Minimum1
Maximum1440
Default30
hostOptimizationExempted
boolean

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.

Defaultfalse
portOptimizationExempted
boolean

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.

Defaultfalse
resolution
string

Screen resolution to negotiate with the RDP server for the session.

Valid values[ "1024x768", "1280x720", "1920x1080" ]
Default"1280x720"
colorDepth
integer

Color depth, in bits per pixel, to negotiate with the RDP server for the session.

Valid values[ 8, 16, 24 ]
Default16
keyboardLayout
string

Keyboard layout advertised to the RDP server. If omitted, the server's default layout is used.

Valid values[ "en-us-qwerty", "en-gb-qwerty", "de-de-qwertz", "fr-fr-azerty", "fr-be-azerty", "fr-ch-qwertz", "de-ch-qwertz", "hu-hu-qwertz", "it-it-qwerty", "ja-jp-qwerty", "no-no-qwerty", "pt-br-qwerty", "es-es-qwerty", "es-latam-qwerty", "sv-se-qwerty", "tr-tr-qwerty", "failsafe" ]
windowsDomain
string

Optional Windows domain to use when authenticating against the RDP server. If omitted, no domain is sent.

securityMode
string

RDP security protocol to negotiate with the target host. nla (Network Level Authentication) is preferred; any lets the server pick.

Valid values[ "nla", "nla-ext", "tls", "rdp", "vmconnect", "any" ]
Default"any"
audioRedirection
boolean

Whether audio redirection from the remote host to the Client is permitted for this Entitlement.

Defaultfalse
BrokeredSshEntitlement
object (BrokeredSshEntitlement)
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
created
string (date-time)

Create date.

updated
string (date-time)

Last update date.

readOnly
boolean

Whether the entity is protected from manual updates and deletes.

Examplefalse
tags
Array of string

Array of tags.

Example[ "developer", "api-created" ]
string
type
string

The type of the Entitlement.

Valid values[ "Network", "BrokeredRdp", "BrokeredSsh" ]
Default"Network"
ExampleNetwork
disabled
boolean

If true, the Entitlement will be disregarded during authorization.

Defaultfalse
site
string (uuid)

ID of the Site for this Entitlement.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
siteName
string

Name of the Site for this Entitlement. For convenience only.

ExampleDefault Site
conditionLogic
string

Whether all the Conditions must succeed to have access to this Entitlement or just one.

Valid values[ "and", "or" ]
Default"and"
conditions
Array of string

List of Condition IDs applied to this Entitlement.

Min items1
string (uuid)
Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
optimizationScore
string

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.

Valid values[ "NotLinked", "Unused", "Overprovisioned", "InsufficientData", "NotInUse", "NotAnalyzed", "OptimizedWithExemptions", "Optimized" ]
Default"InsufficientData"
optimizationScorePercentage
integer

Numeric percentage score representing how optimized this Entitlement is based on usage data. Licensed feature.

host
string

Hostname or IP address of the target host.

Example192.34.220.15
port
integer

Port number of the target host.

Minimum1
Maximum65535
Example3389
recordingEnabled
boolean

Whether sessions to this entitlement are recorded.

Defaultfalse
monitoringEnabled
boolean

Whether sessions to this entitlement can be monitored live.

Defaultfalse
disclosureMessage
string

Optional message shown to the user before the session starts. When set, the client requires the user to accept it before connecting.

credentialsName
string

Name of the Credentials secret used for injection at session establishment. The secret must be of the Credentials or SSH Key type.

ExampleRDP_SERVICE_ACCOUNT
appShortcut
object (BrokeredShortcut)

Shortcut configuration for the brokered session, displayed to the user in the client.

name
string

Name for the shortcut which will be visible on the Client UI.

ExampleWin desktop u3543
description
string

Description for the shortcut which will be visible on the Client UI.

Default""
ExampleThis is information that will appear in the client, for the user to read.
groupName
string

Group name this shortcut is to be grouped by in the client.

ExampleRemote Desktops
colorCode
integer

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
Minimum1
Maximum20
Default1
clipboardSharing
boolean

Whether clipboard sharing between Client and remote host is permitted for this Entitlement.

Defaultfalse
fileTransfer
boolean

Whether file transfers between Client and remote host are permitted for this Entitlement.

Defaultfalse
idleTimeoutMinutes
integer

Idle-session timeout in minutes. The session is terminated after this many minutes without user activity.

Minimum1
Maximum1440
Default30
hostOptimizationExempted
boolean

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.

Defaultfalse
portOptimizationExempted
boolean

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.

Defaultfalse
terminalType
string

Terminal type advertised to the SSH server for the session (TERM environment variable).

Valid values[ "ansi", "vt220", "linux", "xterm", "xterm-256color" ]
Default"xterm-256color"
keepAliveIntervalSeconds
integer

Interval, in seconds, between SSH keep-alive messages sent to the target host. Must be 0 (disabled) or between 2 and 30.

Minimum0
Maximum30
Default30
hostKeyVerificationPolicy
string

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.

Valid values[ "OFF", "TOFU", "ENFORCED" ]
Default"TOFU"
401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.