REST API - GET Proxy Clients for Cloud Apps Pseudo Clients

This operation returns the list of all proxy clients for cloud apps virtual clients.

Request

Syntax
GET webservice/Client/proxy/CloudApps?cAppType=cAppType HTTP/1.1
Host: host name
Accept: application/xml
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

cAppType

Instance type of the cloud apps client. Valid values are: 1 for Gmail, 2 for Google Drive, and 3 for Salesforce.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or the Command Center used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Name

Description

Elements

cAppType

Instance type of the cloud apps client. Valid values are: 1 for Gmail, 2 for Google Drive, and 3 for Salesforce.

PseudoClientType

hostName

The long name of the client, for example, client.domain.company.com.

client

clientId

The system-generated ID assigned to the virtualization client.

client

clientName

The name of the virtualization client.

client

displayName

Display name of the client.

client

clientGUID

The globally unique identifier for the virtualization client.

client

Examples

Sample Request
GET webservice/Client/proxy/CloudApps?cAppType=1 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response

XML:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <TMMsg_GetClientsForPackage vendor="0">
  <clients hostName="ACLatest" clientId="2" clientName="aclatest" _type_="3" csGUID="AFFD6890-B1A5-4B4D-A59E-F720252C9473" />
</TMMsg_GetClientsForPackage>

JSON:

{ 
   "vendor":0,
   "clients":[ 
     { 
       "hostName":"ACLatest",
       "clientId":2,
       "clientName":"aclatest",
       "_type_":3,
       "csGUID":"AFFD6890-B1A5-4B4D-A59E-F720252C9473"
     }
   ]
 }
×

Loading...