Citrix DaaS REST APIs
How to add an item to a zone in Citrix DaaS
Use REST APIs to add an item to a zone in your Citrix DaaS (formerly Citrix Virtual Apps and Desktops service) site.
Follow the prerequisites and examples to get started with this API.
You can make API requests using the PowerShell code, C# code, Python, or any tool that supports invoking the REST API.
Prerequisites to add an item to a zone in Citrix DaaS
- Read the Get started with Citrix Cloud APIs section to ensure that you have the
bearer token. - Get
siteidfrom How to get site id API. - Get the
nameOrIdof the zone from How to get all zones API. - Get the item to be added to zone ready with id, name and type.
- Invoke the API described in this document from a client host or from the API exploration tab to add an item to the zone.
Add an item to a zone in your site using any REST API tool
Learn from the following example to add an item to a zone in your Citrix DaaS site using any REST API tool.
Request
POST https://api.cloud.com/cvad/manage/Zones/{nameOrId}/$addItems HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8
Authorization: CWSAuth bearer=<token-from-prerequisites>
Citrix-CustomerId: loy6oujtu6a4
Citrix-InstanceId: 22ded57c-0306-47e4-b6e8-fed6252759e1
{
"items": [
{
"Id": "S-1-5-21-485472016-3960497763-2048154794-500",
"Name": "Domain\\User01",
"ItemType": "User"
}
]
}
<!--NeedCopy-->
Response
HTTP/1.1 204 NoContent
citrix-transactionid: 6a12e39f-b9df-4ac2-91bb-7acbbcca0693
content-Length: 319
content-Type: application/json; charset=utf-8
date: "Tue, 08 Dec 2020 12:10:05 GMT"
Server: Citrix Systems, Inc.
<!--NeedCopy-->
Add an item to a zone in your site using PowerShell
Learn from the following example to add an item to a zone in your Citrix DaaS site using any PowerShell code.
function AddItemToZone{
param (
[Parameter(Mandatory=$true)]
[string] $customerid,
[Parameter(Mandatory=$true)]
[string] $siteid,
[Parameter(Mandatory=$true)]
[string] $nameOrId,
[Parameter(Mandatory=$true)]
[string] $bearerToken,
[Parameter(Mandatory=$true)]
[string] $body
)
$requestUri = [string]::Format("https://api.cloud.com/cvad/manage/Zones/{0}/`$addItems", $nameOrId)
$headers = @{
"Accept" = "application/json";
"Content-Type"="application/json";
"Authorization" = "CWSAuth Bearer $bearerToken";
"Citrix-CustomerId" = $customerid;
"Citrix-InstanceId" = $siteid;
}
$response = Invoke-RestMethod -Uri $requestUri -Method POST -Headers $headers -Body $body
return $response
}
$customerId = "customer1"
$siteId = "61603f15-cdf9-4c7f-99ff-91636601a795"
$bearerToken = "ey1.."
$nameOrId = "56f1cbf3-1cc6-40cd-9c82-c95633ba88bb"
$body = @"
{
"items": [
{
"Id": "S-1-5-21-485472016-3960497763-2048154794-500",
"Name": "Domain\\User01",
"ItemType": "User"
}
]
}
"@
$response = AddItemToZone $customerid $siteid $nameOrId $bearerToken $body
<!--NeedCopy-->
Add an item to a zone in your site using C# code
Learn from the following example to add an item to a zone in your Citrix DaaS site using any C# code.
public static async Task<string> AddItemToZone(
string customerid,
string siteid,
string nameOrId,
string bearerToken,
ZonedItemsRequestModel model)
{
var requestUri = string.Format("https://api.cloud.com/cvad/manage/Zones/{0}/$addItems", nameOrId);
using (var client = new HttpClient())
{
client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
client.DefaultRequestHeaders.Add("Citrix-CustomerId", customerid);
client.DefaultRequestHeaders.Add("Citrix-InstanceId", siteid);
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("CWSAuth Bearer" + bearerToken);
var jsonBody = JsonConvert.SerializeObject(model, new JsonSerializerSettings
{
Converters = new JsonConverter[] { new StringEnumConverter() }
});
var response = await client.PostAsync(requestUri, new StringContent(jsonBody, Encoding.UTF8, "application/json"));
if (response != null)
{
var content = await response.Content.ReadAsStringAsync();
return content;
}
return null;
}
}
<!--NeedCopy-->
Add an item to a zone in your site using Python
Learn from the following example to add an item to a zone in your Citrix DaaS site using Python.
import requests
def add_item_to_zone(bearerToken, customerid, siteid, nameOrId):
request_uri = "https://api.cloud.com/cvad/manage/Zones/{0}/$addItems".format(nameOrId)
headers = {
'Authorization': 'CWSAuth Bearer %s' % bearerToken,
'Citrix-CustomerId': customerid,
'Citrix-InstanceId': siteid,
'Content-Type': 'application/json',
'Accept': 'application/json'
}
payload = json.dumps({
"items": [
{
"Id": "S-1-5-21-485472016-3960497763-2048154794-500",
"Name": "Domain\\User01",
"ItemType": "User"
}
]
})
response = requests.post(request_uri, headers = headers, verify = False, data = payload)
return response.json()
<!--NeedCopy-->
How to add an item to a zone in Citrix DaaS
Copied!
Failed!