How to get a single use URL for an arbitrary site using Citrix Remote Browser Isolation
Use the Citrix Remote Browser Isolation service API to launch arbitrary addresses within the hosted environment, without permanently publishing the URL.
The returned value is a launch.cloud.com URL. You might be able to use this returned URL only once or it might time out if not used within 10 minutes.
Prerequisites
customerIdbearer token
For more information on getting a customerId and bearer token, see the Get started with Citrix Cloud APIs section.
Create a single use URL using any REST API tool
Learn from the following example to create a single-use launch.cloud.com URL
using any REST API tool.
Request
POST https://session.browser.cloud.com/{customer}/singleuse/$launchurl HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: CwsAuth bearer=<token-from-call-to-trust>
{
"address": "https://www.citrix.com",
"name": "Citrix",
"userIdentity": { "username": "<user@example.com>" }
}
<!--NeedCopy-->
Response
HTTP/1.1 200 OK
Content-Length: 89
Content-Type: application/json;charset=utf-8
{
"launchUrl": "https://launch.cloud.com/{customer}?ticket=75DC45..."
}
<!--NeedCopy-->
Interpreting the request
The following JSON object is a fully defined launch request. All fields
except address are optional and can be omitted if the default value is
acceptable.
{
"address": "https://www.citrix.com",
"name": "Citrix Remote Browser Isolation",
"geo": "wus",
"whitelist": "*:*",
"filterProfile": "None",
"userIdentity": {
"username": "user@example.com",
"clientIP": "198.51.100.1"
},
"policies": {
"copyPaste": true,
"printing": false,
"nonKiosk": false,
"disableRegionFailover": false,
"sessionIdleTimeout": 10,
"sessionIdleTimeoutWarning": 2
}
}
<!--NeedCopy-->
LaunchModel
| Property Name | Type | Description |
|---|---|---|
| name | string | Title of the page in the client browser. |
| address | string | [Required] Fully qualified URL to launch within the session. |
| geo | string | Geographical region to host the remote session. The values are wus (West US), weurope (West Europe), seasia (Southeast Asia), and auto (Select a region based on the user’s IP address). The default value is wus. |
| whitelist | string | List of sites that the hosted browser is allowed to contact. Entries are in the format hostname:port number, separated by newlines, with asterisks as wild cards. The default value is *:*, which allows all traffic. |
| userIdentity | object | Describes the user launching the session. |
| policies | object | Defines the features available within the session. |
UserIdentity
| Property Name | Type | Description |
|---|---|---|
| username | string | Name of the user |
| clientIP | string | IP address of the user. Required when the geo field is auto. |
Policies
| Property Name | Type | Description |
|---|---|---|
| copyPaste | boolean | Enable clipboard operations between client and session. Disabled by default. |
| printing | boolean | Enable printing of remote pages. Disabled by default. |
| nonKiosk | boolean | Do not run the hosted browser in kiosk mode. Disabled by default. |
| disableRegionFailover | boolean | Require the session to run in the requested geographical region, allowing the session to fail rather than be relocated to another region. By default, sessions are relocated to a functional region if the requested one is reporting an issue. |
| sessionIdleTimeout | integer | Number of minutes to allow the session to remain idle before closing automatically. Default is 10 minutes. |
| sessionIdleTimeoutWarning | integer | Number of minutes before an automatic log-off to display a warning dialog to the user. Default is 2 minutes. |
Interpreting the response
The response is a JSON object with a single property, launchUrl. This
URL can be loaded into any web browser to launch the hosted
session with an embedded Citrix Workspace app for HTML5.