Log in to Citrix Cloud account
 
Create an API Client
 
Call an API

You must Sign up for a Citrix Cloud account. For information about signing up, see Signing Up for Citrix Cloud.

Log in to Citrix Cloud account

To use Citrix Cloud Services APIs a Citrix Cloud account is required.

  1. If you are a new user, you must Sign up for a Citrix Cloud account. See Signing Up for Citrix Cloud for more information.
  2. If you are an existing user, use your credentials to log in to your Citrix Cloud account.
Create an API client

To call APIs from a script or an external program, you must create an API client in the Citrix Cloud.

  1. In the Citrix Cloud console, click the menu in the upper left corner of the screen.

  2. Select the Identity and Access Management option from the menu.

    Note: If this option does not appear, you may not have adequate permissions to create an API client. Contact your administrator to get the required permissions.

  3. Select the API Access tab.

     

    Important: Take a note of the customer ID in the description above the Create Client button. You will need it in the later steps.

  4. Name your Secure Client, and click Create Client.

    Note: Deleting a client can impact your integration with Citrix Cloud.

     
  5. The following message appears, ID and Secret have been created successfully. Download or copy the Client Id and Secret.

    Important: Citrix recommends that you use the Client Id and Secret to authenticate Citrix APIs. If you choose to authenticate using a bearer token, see Authenticate to Citrix Cloud using a bearer token. under Call an API

API client scope and permissions

API clients in Citrix Cloud are always tied to one administrator and one customer. The API clients that you create are not visible to other administrators in your organization. If you have access to more than one customer, you must create API client(s) within each customer. You can use these clients to call APIs for these customers.

API clients owned by a Citrix Cloud administrator are automatically restricted to the rights of that administrator, within that customer. For example, if an administrator is restricted to access only notifications, then the API clients also have similar restrictions.

If an administrator’s access is reduced at any point, then the access of all the API clients owned by that administrator is also reduced.

If an administrator’s access is removed from the list of administrators within that customer, then all the API clients within that customer are automatically deleted.

Customer ID

The Citrix Cloud API requires a customer ID when calling REST APIs, as part of the URL. The parameter sometimes must be the special value root or the specific customer that you are targeting.

To get the customer ID, go to the Identity and Access Management page and click API Access tab. You can see the customer ID in the description above the Create Client button.

 
Call an API

You can call an API using either a Client ID and Secret or a Citrix Cloud bearer token.

Citrix recommends using a Client ID and Secret method to call an API.

Call an API using Client ID and Secret

  1. Navigate to any Citrix Cloud service, under API Exploration click any API from the list and click Try this API button.

  2. In the request Authorization header parameter description, click Generate here. The Set Authentication window appears.

  3. Enter Client ID and Secret keys that were generated while creating an API client. Click Generate.

  4. A bearer token is generated using the Client ID and Secret.

Call an API using the Citrix Cloud bearer token

In the request Authorization header, use the 'token' property returned from the below authentication API. 

POST https://trust.citrixworkspacesapi.net/{customer}/tokens/clients

Parameter Parameter Type Value
customer path Use the special value root for this API.
Accept header application/json
Content-Type header application/json
 

 

Prefix the token with CwsAuth Bearer=.

For example, Authorization: CwsAuth Bearer=ey1..

Request sample

POST https://trust.citrixworkspacesapi.net/root/tokens/clients HTTP/1.1
Accept: application/json
Content-Type: application/json

Response sample

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 2623
Content-Type: application/json; charset=utf-8
Date: Fri, 23 Dec 2016 21:53:37 GMT
X-Cws-TransactionId: 6c3db4d6-125f-4ea3-b938-882bc5dc3caf

{
  "principal": "john.down@citrix.com",
  "subject": "16..",
  "token": "ey1..",
  "openIdToken": "ey1..",
  "expiresIn": 3600
}