An existing browser profile for the Compass Browser.

GET

Retrieves all the details of an existing browser profile for the Compass Browser.

For a list of the available parameters for a browser profile and how to configure them, see Browser Configuration profiles (API) .

Parameters

Parameter
Description
GUIDRequired. The GUID for the Compass browser profile you want to retrieve. To find the GUIDs for all active profiles, use GET profile/catalog.

Example request


Request

curl -v -L -b cookie -c cookie -X GET https://bc.qwe.com/mocana-app-control/rest/profile/mocana-browser/ 
88608694-1f37-4087-bc01-9b1cef2c983a
CODE

Response

{
  "message": "",
  "profiles": {
    "data": {
      "allow_bookmarks": true,
      "allow_email": true,
      "allow_history": true,
      "allow_search": true,
      "allow_url_entry": true,
      "sites": [
        {
          "allow_close": true,
          "icon_id": "",
          "id": "d43830f1-1df3-4411-87b4-2c4de1a2e62f",
          "name": "Basic authentication",
          "url": "https://abel.qwe.local/basic/"
        },
        {
          "allow_close": true,
          "icon_id": "",
          "id": "1577ff53-47de-4efa-ad7a-9e05d64c5d2a",
          "name": "Digest",
          "url": "https://abel.qwe.local/digest/"
        },
        {
          "allow_close": true,
          "icon_id": "",
          "id": "2beff208-a237-4f67-98d1-22f5cb01cd97",
          "name": "Home",
          "url": "https://abel.qwe.local/secured/"
        },
        {
          "allow_close": true,
          "icon_id": "",
          "id": "b674e0fb-0bbb-455e-87f6-6535bf4627d6",
          "name": "Sharepoint",
          "url": "https://cain"
        },
        {
          "allow_close": false,
          "icon_id": "",
          "id": "133876a5-b540-49fa-82e0-bd20e3e283ee",
          "name": "jira",
          "url": "https://jira.qwe.com/login.jsp"
        }
      ],
      "theme_color": 15674157,
      "title": "Secure Intranet with Multi-App Login"
    },
    "profile_desc": "The secure browser profile for intranet sites that are permitted for employees and Multi-app login, which allows the user to login to one website and thereby unlock all other .related websites.",
    "profile_id": "88608694-1f37-4087-bc01-9b1cef2c983a",
    "profile_name": "Intranet - secure iOS browser for Multi-App Login",
    "profile_type": "browser",
    "profile_url": "https://bc.qwe.com/mocana-app-control/rest/profile/88608694-1f37-4087-bc01-9b1cef2c983a"
  },
  "status": "OK"
} 
CODE

POST

Updates an existing profile for the Compass Browser. You can change the settings for the browser and the files for the website icons.

If you want to reset the website icon to the default icon, leave an empty value for the specific browser profile parameter. The policy console interprets the empty value as a request to use the default website icon.

Parameters

When you add a new site to a profile, you must also pass in the existing site data and icons in the POST profile/mocana-browser/{GUID} request. The policy console assumes that if a parameter is not included in an update request, then that parameter does not apply to that profile.

Example request

In this example request, the only update in the API request is changing the icon file for the first website from Executives.png toTraining.png. To execute this request:

  • Specify the GUID for the existing profile in the API call
  • Specify the new icon file in the site_icon[0] parameter (that is, site_icon[0]=@icons/Training.png)
  • Pass in the remainder of the parameters that have not changed.

For a list of the available parameters for a browser profile and how to configure them, see Browser Configuration profiles (API).

The \ character breaks a long command line into several lines for readability. The shell interprets this as a single line.


Request

curl -b c.txt -c c.txt -X POST https://bc.qwe.com/mocana-app-control/rest/profile/mocana-browser/
cbaa3bff-0585-4d60-8474-eb2b1d9c7cc8 \
-F profileName="Newest Compass Browser profile for part-time employees" \
-F profileDesc="Newest Compass Browser profile for part-time employees to access payroll information" \
-F site_icon[0]=@icons/Training.png \ 
-F site_icon[1]=@icons/Finance.png \
-F site_icon[2]=@icons/IT_Admin.png \
-F browser_profile_data='{ \
  "allow_history":true, \
  "theme_color":15674157, \
  "allow_url_entry":true, \
  "title":"Part-Time Employees", \
  "sites":[ {"icon_id":"", \
             "name":"Execs - Basic authentication",\
             "url":"https://abel.qwe.local/basic/", \
             "allow_close":true, 
             "id":"45d50905-0ecc-4726-ad70-338f7c068026"}, \
            {"icon_id":"", \
             "name":"Finance - Digest", \ 
             "url":"https://abel.qwe.local/digest/", \
             "allow_close":true, \
             "id":"db6dee27-e85c-4a49-9973-6dd0661be24c"}, \
            {"icon_id":"", \
             "name":"Mobile Users - Sharepoint", \
             "url":"https://bc.qwe.com/login", \
             "allow_close":true, \
             "id":"8a89ac0a-434c-4b80-88f2-a23a28bd19a5"}], \
  "launcher_icon_location":null, \
  "allow_bookmarks":true, \
  "allow_email":true, \
  "allow_search":true}'
CODE

The resulting JSON shows a new icon_id and a new icon_url for the updated icon of the first website:

Response

{
  "message": "",
  "profiles": {
    "data": {
      "profile_data": {
        "allow_bookmarks": true,
        "allow_email": true,
        "allow_history": true,
        "allow_search": true,
        "allow_url_entry": true,
        "sites": [
          {
            "allow_close": true,
            "icon_id": "eff23aa3-2a3c-4b06-9f6b-921b81095f5e",
            "icon_url": "https://bc.qwe.com/mocana-app-control/rest/files/eff23aa3-2a3c-4b06-9f6b-921b81095f5e",
            "id": "45d50905-0ecc-4726-ad70-338f7c068026",
            "name": "Execs - Basic authentication",
            "url": "https://abel.qwe.local/basic/"
          },
          {
            "allow_close": true,
            "icon_id": "c9421164-ea7d-415a-ba1f-b13362f9302b",
            "icon_url": "https://bc.qwe.com/mocana-app-control/rest/files/c9421164-ea7d-415a-ba1f-b13362f9302b",
            "id": "db6dee27-e85c-4a49-9973-6dd0661be24c",
            "name": "Finance - Digest",
            "url": "https://abel.qwe.local/digest/"
          },
          {
            "allow_close": true,
            "icon_id": "134e1a9b-f950-4981-a2a0-ac8cc075ba41",
            "icon_url": "https://bc.qwe.com/mocana-app-control/rest/files/134e1a9b-f950-4981-a2a0-ac8cc075ba41",
            "id": "8a89ac0a-434c-4b80-88f2-a23a28bd19a5",
            "name": "Mobile Users - Sharepoint",
            "url": "https://bc.qwe.com/login"          }
        ],
        "theme_color": 15674157,
        "title": "Part-Time Employees"
      },
      "profile_data_id": "280326a4-d3ed-48a2-a79b-cde1e07593d5",
      "profile_data_stamp": "2014-05-13 00:06:07.0"
    },
    "profile_desc": "Newest Compass Browser profile for part-time employees to access payroll information",
    "profile_id": "cbaa3bff-0585-4d60-8474-eb2b1d9c7cc8",
    "profile_name": "Newest Compass Browser profile for part-time employees",
    "profile_type": "browser",
    "profile_url": "https://bc.qwe.com/mocana-app-control/rest/profile/cbaa3bff-0585-4d60-8474-eb2b1d9c7cc8"
  },
  "status": "OK"
}
CODE

DELETE

Removes an existing profile for the Compass Browser from the policy console.

Parameters

ParameterDescription
GUIDRequired. The GUID for the Compass browser profile you want to archive. To find the GUIDs for all active profiles, use GET profile/catalog.

Example request

Request

curl -v -L -b cookie -c cookie -X DELETE \
  https://bc.qwe.com/mocana-app-control/rest/profile/mocana-browser/ddfc3777-fc21-433c-bcd1-c72f88b455f0
CODE

Response

{
  "message": "",
  "status": "OK"
} 
CODE