{"swagger":"2.0","info":{"version":"v1","title":"WEM Public API Guide"},"host":"{api}.wem.cloud.com","schemes":["https"],"consumes":["application/json; charset=utf-8"],"produces":["application/json; charset=utf-8"],"paths":{"/services/wem/action/applications":{"get":{"tags":["Application"],"summary":"Query Applications by Parameters","operationId":"ApplicationWeb_Query","parameters":[{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"siteId","in":"query","description":"The site ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The offset is used to determine the starting position of the query results.","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"The limit is used to determine the maximum number of results returned.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ApplicationModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Application"],"summary":"Update an Application","operationId":"ApplicationWeb_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/ApplicationModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Application"],"summary":"Create an Application","operationId":"ApplicationWeb_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/ApplicationModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Application"],"summary":"Delete Applications","operationId":"ApplicationWeb_Delete","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/IdListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Delete Action"},"/services/wem/users/{id}":{"get":{"tags":["Assignment Target"],"summary":"Query Assignment Targets by Identity","operationId":"Item_QueryById","parameters":[{"name":"id","in":"path","description":"The ID of the resource you want to query.","required":true,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"$ref":"#/definitions/UserModel"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Assignment Target"],"summary":"Delete an Assignment Target","operationId":"Item_Delete","parameters":[{"name":"id","in":"path","description":"The ID of the resource you want to delete.","required":true,"type":"string"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Delete Users"},"/services/wem/users":{"get":{"tags":["Assignment Target"],"summary":"Query Assignment Targets","operationId":"Item_Query","parameters":[{"name":"sid","in":"query","description":"The SID is used to filter the query results.","required":false,"type":"string"},{"name":"siteId","in":"query","description":"The configuration set ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/UserModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Assignment Target"],"summary":"Update an Assignment Target","operationId":"Item_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/UserModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Assignment Target"],"summary":"Create an Assignment Target","operationId":"Item_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/UserModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Users"},"/services/wem/export":{"get":{"tags":["Backup"],"summary":"Query All Backups","description":"Lists the backups: a configuration set backed up manually or automatically, and settings backed up\r\nfrom a configuration set.","operationId":"Export_GetExport","parameters":[{"name":"includeExtra","in":"query","description":"Set to true to populate the \"extra.metadata\" property of each item. The default value is false.","required":false,"type":"boolean"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ExportModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Export"},"/services/wem/export/multiple":{"delete":{"tags":["Backup"],"summary":"Delete Multiple Backups","description":"Deletes the specified backups, for example\r\n{ \"stringList\": [ \"site/MyConfigSet_20260817/site.json\" ] }, using the paths returned by\r\nGET services/wem/export.","operationId":"Export_DeleteMultiple","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/StringListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Delete Export"},"/services/wem/sites/{id}":{"get":{"tags":["Configuration Set"],"summary":"Query Configuration Sets by Identity","operationId":"Site_QueryById","parameters":[{"name":"id","in":"path","description":"The ID of the resource you want to query.","required":true,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"$ref":"#/definitions/SiteModel"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Configuration Set"],"summary":"Delete a Configuration Set","operationId":"Site_Delete","parameters":[{"name":"id","in":"path","description":"The ID of the resource you want to delete.","required":true,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Delete Sites"},"/services/wem/sites/$export":{"get":{"tags":["Configuration Set"],"summary":"Export a Configuration Set","operationId":"Site_Export","parameters":[{"name":"id","in":"query","description":"The ID of the resource you want to export.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name of the resource you want to export.","required":false,"type":"string"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"type":"object"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Sites"},"/services/wem/sites/$import":{"post":{"tags":["Configuration Set"],"summary":"Import a Configuration Set","operationId":"Site_Import","parameters":[{"name":"targetSiteId","in":"query","description":"The ID of the configuration set you want to import. If specified, this will overwrite the configurations in the configuration set. If not specified, a new configuration set will be created and used.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"type":"object"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Create Sites"},"/services/wem/sites/$replicate":{"post":{"tags":["Configuration Set"],"summary":"Replicate a Configuration Set","operationId":"Site_Replicate","parameters":[{"name":"id","in":"query","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","required":false,"type":"string"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Create Sites"},"/services/wem/sites":{"get":{"tags":["Configuration Set"],"summary":"Query Configuration Sets","operationId":"Site_Query","parameters":[{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"includeHidden","in":"query","description":"This flag is used to determine if it is necessary to include hidden configuration sets.","required":false,"type":"boolean"},{"name":"includeUnboundAgentsSite","in":"query","description":"This flag is used to determine if it is necessary to include the unbound agents configuration set.","required":false,"type":"boolean"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/SiteModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Configuration Set"],"summary":"Update a Configuration Set","operationId":"Site_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/SiteModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Configuration Set"],"summary":"Create a Configuration Set","operationId":"Site_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/SiteModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Sites"},"/services/wem/machines/{id}":{"get":{"tags":["Directory Object"],"summary":"Query Directory Objects by Identity","operationId":"AdObject_QueryById","parameters":[{"name":"id","in":"path","description":"The ID of the resource you want to query.","required":true,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"$ref":"#/definitions/MachineModel"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Directory Object"],"summary":"Delete a Directory Object","operationId":"AdObject_Delete","parameters":[{"name":"id","in":"path","description":"The ID of the resource you want to delete.","required":true,"type":"string"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Delete Machines"},"/services/wem/machines":{"get":{"tags":["Directory Object"],"summary":"Query Directory Objects","operationId":"AdObject_Query","parameters":[{"name":"sid","in":"query","description":"The SID is used to filter the query results.","required":false,"type":"string"},{"name":"siteId","in":"query","description":"The configuration set ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"type","in":"query","description":"The type is used to filter the query results.","required":false,"type":"string"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/MachineModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Directory Object"],"summary":"Update a Directory Object","operationId":"AdObject_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/MachineModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Directory Object"],"summary":"Create a Directory Object","operationId":"AdObject_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/MachineModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Machines"},"/services/wem/action/environmentVariables":{"get":{"tags":["Environment Variable"],"summary":"Query Environment Variables by Parameters","operationId":"EnvironmentVariableAction_Query","parameters":[{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"siteId","in":"query","description":"The site ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The offset is used to determine the starting position of the query results.","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"The limit is used to determine the maximum number of results returned.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/EnvironmentVariableActionModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Environment Variable"],"summary":"Update an Environment Variable","operationId":"EnvironmentVariableAction_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/EnvironmentVariableActionModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Environment Variable"],"summary":"Create an Environment Variable","operationId":"EnvironmentVariableAction_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/EnvironmentVariableActionModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Environment Variable"],"summary":"Delete Environment Variables","operationId":"EnvironmentVariableAction_Delete","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/IdListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Delete Action"},"/services/wem/export/files":{"get":{"tags":["File"],"summary":"Query All Files","description":"Lists the exported reports, script files, and Group Policy (ADMX) templates.","operationId":"File_GetFiles","parameters":[{"name":"includeMetadata","in":"query","description":"Set to true to populate the \"extra.metadata\" property of each item. The default value is false.","required":false,"type":"boolean"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ExportModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["File"],"summary":"Delete Files","description":"Deletes the specified exported reports, script files, and Group Policy (ADMX) templates, for\r\nexample { \"stringList\": [ \"files/report.zip\", \"gpo/template.zip\" ] }, using the paths returned by\r\nGET services/wem/export/files.","operationId":"File_DeleteFiles","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/StringListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Delete Export"},"/services/wem/action/groupPolicyObjects":{"get":{"tags":["Group Policy Object"],"summary":"Query Group Policy Objects by Parameters","operationId":"GroupPolicyObjectWeb_Query","parameters":[{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"siteId","in":"query","description":"The site ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"includeRegOperation","in":"query","description":"This flag is used to determine if it is necessary to include registry operations.","required":false,"type":"boolean"},{"name":"offset","in":"query","description":"The offset is used to determine the starting position of the query results.","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"The limit is used to determine the maximum number of results returned.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/GroupPolicyObjectModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Group Policy Object"],"summary":"Update a Group Policy Object","operationId":"GroupPolicyObjectWeb_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/GroupPolicyObjectModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Group Policy Object"],"summary":"Create a Group Policy Object","operationId":"GroupPolicyObjectWeb_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/GroupPolicyObjectModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Group Policy Object"],"summary":"Delete Group Policy Objects","operationId":"GroupPolicyObjectWeb_Delete","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/IdListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Delete Action"},"/services/wem/action/networkDrives":{"get":{"tags":["Network Drive"],"summary":"Query Network Drives by Parameters","operationId":"NetworkDriveAction_Query","parameters":[{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"siteId","in":"query","description":"The site ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The offset is used to determine the starting position of the query results.","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"The limit is used to determine the maximum number of results returned.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/NetworkDriveModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Network Drive"],"summary":"Update a Network Drive","operationId":"NetworkDriveAction_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/NetworkDriveModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Network Drive"],"summary":"Create a Network Drive","operationId":"NetworkDriveAction_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/NetworkDriveModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Network Drive"],"summary":"Delete Network Drives","operationId":"NetworkDriveAction_Delete","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/IdListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Delete Action"},"/services/wem/action/printers":{"get":{"tags":["Printer"],"summary":"Query Printers by Parameters","operationId":"PrinterWeb_Query","parameters":[{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"siteId","in":"query","description":"The site ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The offset is used to determine the starting position of the query results.","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"The limit is used to determine the maximum number of results returned.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PrinterModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Printer"],"summary":"Update a Printer","operationId":"PrinterWeb_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/PrinterModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Printer"],"summary":"Create a Printer","operationId":"PrinterWeb_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/PrinterModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Printer"],"summary":"Delete Printers","operationId":"PrinterWeb_Delete","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/IdListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Delete Action"},"/services/wem/action/registryEntries":{"get":{"tags":["Registry Entry"],"summary":"Query Registry Entries by Parameters","operationId":"RegistryEntryAction_Query","parameters":[{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"siteId","in":"query","description":"The site ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The offset is used to determine the starting position of the query results.","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"The limit is used to determine the maximum number of results returned.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/RegistryEntryActionModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Registry Entry"],"summary":"Update a Registry Entry","operationId":"RegistryEntryAction_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/RegistryEntryActionModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Registry Entry"],"summary":"Create a Registry Entry","operationId":"RegistryEntryAction_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/RegistryEntryActionModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Registry Entry"],"summary":"Delete Registry Entries","operationId":"RegistryEntryAction_Delete","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/IdListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Delete Action"},"/services/wem/systemOptimizations/{id}":{"get":{"tags":["System Optimization"],"summary":"Query System Optimization Configurations by Identity","operationId":"SystemUtilitySetting_QueryById","parameters":[{"name":"id","in":"path","description":"The ID of the resource you want to query.","required":true,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"$ref":"#/definitions/SystemOptimizationModel"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query SystemOptimizations"},"/services/wem/systemOptimizations":{"get":{"tags":["System Optimization"],"summary":"Query System Optimization Configurations","operationId":"SystemUtilitySetting_Query","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/SystemOptimizationModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["System Optimization"],"summary":"Update a System Optimization Configuration","operationId":"SystemUtilitySetting_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/SystemOptimizationModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Update SystemOptimizations"},"/services/wem/action/virtualDrives":{"get":{"tags":["Virtual Drive"],"summary":"Query Virtual Drives by Parameters","operationId":"VirtualDriveAction_Query","parameters":[{"name":"id","in":"query","description":"The ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"siteId","in":"query","description":"The site ID is used to filter the query results.","required":false,"type":"integer","format":"int64"},{"name":"name","in":"query","description":"The name is used to filter the query results.","required":false,"type":"string"},{"name":"offset","in":"query","description":"The offset is used to determine the starting position of the query results.","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"The limit is used to determine the maximum number of results returned.","required":false,"type":"integer","format":"int64"},{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"}],"responses":{"200":{"description":"Query completed successfully.","schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/VirtualDriveModel"}}}},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"404":{"$ref":"#/responses/404"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"put":{"tags":["Virtual Drive"],"summary":"Update a Virtual Drive","operationId":"VirtualDriveAction_Update","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/VirtualDriveModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"post":{"tags":["Virtual Drive"],"summary":"Create a Virtual Drive","operationId":"VirtualDriveAction_Create","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/VirtualDriveModel"}}],"responses":{"201":{"$ref":"#/responses/201"},"400":{"$ref":"#/responses/400"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"delete":{"tags":["Virtual Drive"],"summary":"Delete Virtual Drives","operationId":"VirtualDriveAction_Delete","parameters":[{"$ref":"#/parameters/Accept"},{"$ref":"#/parameters/Authorization"},{"$ref":"#/parameters/CitrixTransactionId"},{"$ref":"#/parameters/CitrixCustomerId"},{"name":"Body","in":"body","required":false,"schema":{"$ref":"#/definitions/IdListModel"}}],"responses":{"204":{"$ref":"#/responses/204"},"400":{"$ref":"#/responses/400"},"404":{"$ref":"#/responses/404"},"409":{"$ref":"#/responses/409"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"415":{"$ref":"#/responses/415"}}},"x-summary":"Query Create Update Delete Action"}},"definitions":{"ApplicationModel":{"description":"Model of Application object","required":["name"],"type":"object","properties":{"state":{"description":"Application state","enum":["Disabled","Enabled","Maintenance"],"type":"string"},"actionType":{"description":"Application action type","enum":["CreateAppShortcut"],"type":"string"},"appType":{"description":"Application type","enum":["InstallerApplication","Storefront","Url","FileFolder"],"type":"string"},"displayName":{"description":"Application display name","type":"string"},"startMenuPath":{"description":"Application start menu location","type":"string"},"commandLine":{"description":"Installed application command line","type":"string"},"workingDir":{"description":"Installed application working directory","type":"string"},"parameter":{"description":"Installed application parameter","type":"string"},"folderPath":{"description":"File or folder application target","type":"string"},"url":{"description":"URL application shortcuts URL","type":"string"},"sfUrl":{"description":"Storefront application url","type":"string"},"sfResource":{"description":"Storefront application resource ID","type":"string"},"sfDisplayName":{"description":"Storefront application resource display name","type":"string"},"iconStream":{"description":"Application icon stream","type":"string"},"hotKey":{"description":"Application hotkey","type":"string"},"windowsStyle":{"description":"Application windows style","enum":["Minimized","Normal","Maximized"],"type":"string"},"selfHealing":{"description":"Enable application self healing or not","type":"boolean"},"enforceIconLocation":{"description":"Enforce application icon location or not","type":"boolean"},"locationX":{"format":"int32","description":"Application horizontal icon location","type":"integer"},"locationY":{"format":"int32","description":"Application vertical icon location","type":"integer"},"ignoreSelfService":{"description":"Application is shown in self service or not","type":"boolean"},"inFavorFolder":{"description":"Place application in the favor folder or not","type":"boolean"},"assignmentCount":{"format":"int64","description":"Whether application gets AssignmentCount","type":"integer","readOnly":true},"id":{"format":"int64","description":"Identity of this resource","type":"integer","readOnly":true},"name":{"description":"Display name of this resource","type":"string"},"description":{"description":"Description of this resource","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this resource belongs","type":"integer","readOnly":true},"revision":{"format":"int64","description":"The revision number of this resource","type":"integer","readOnly":true}},"example":{"state":"Maintenance","actionType":"CreateAppShortcut","appType":"InstallerApplication","displayName":"Display name example","startMenuPath":"Start Menu\\Programs","commandLine":"%windir%\\system32\\cmd.exe","workingDir":"%windir%\\system32","parameter":"p1 p2 p3 p4","folderPath":"C:\\Windows","url":"https://www.google.com/","sfUrl":"https://example.cloud.com/Citrix/Store","sfResource":"46F95401-48AE-421E-AB56-2213AEB9A577","sfDisplayName":"Chrome","iconStream":"iVBORw0KGgoAAAAxxxxxxxxxxxx=","hotKey":"Ctrl+Alt+A","windowsStyle":"Normal","selfHealing":true,"enforceIconLocation":true,"locationX":100,"locationY":100,"ignoreSelfService":true,"inFavorFolder":true,"assignmentCount":0,"id":1,"name":"Application example","description":"Description example","siteId":1,"revision":0}},"IdListModel":{"type":"object","properties":{"idList":{"type":"array","items":{"format":"int64","type":"integer"}}},"example":{"idList":[1,2]}},"DirectoryContextModel":{"description":"Model of Directory Context of Universal Claim","required":["identityProvider","tenantId"],"type":"object","properties":{"identityProvider":{"description":"Type of identity provider","enum":["All","AD","AzureAD"],"type":"string"},"forest":{"description":"Forest associated with the Universal Claim","type":"string"},"domain":{"description":"Domain associated with the Universal Claim","type":"string"},"tenantId":{"description":"TenantId associated with the Universal Claim","type":"string"},"idpInstanceId":{"description":"Idp Instance Id associated with the Universal Claim (valid for AAD)","type":"string"}}},"UserModel":{"description":"Model of user-level AD object","required":["name"],"type":"object","properties":{"id":{"format":"int64","description":"Identity of user-level AD object","type":"integer","readOnly":true},"sid":{"description":"SID of user-level AD object","type":"string","readOnly":true},"directoryContext":{"$ref":"#/definitions/DirectoryContextModel"},"name":{"description":"Distinguished name of user-level AD object","type":"string"},"type":{"description":"Type of user-level AD object","enum":["User","Group","OU","AzureADUser","AzureADGroup"],"type":"string","readOnly":true},"description":{"description":"Description of user-level AD object","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this user-level AD object belongs","type":"integer","readOnly":true},"enabled":{"description":"If this user-level AD object is enabled","type":"boolean"},"priority":{"format":"int64","description":"Priority of user-level AD object","type":"integer"}},"example":{"id":3,"sid":"S-1-5-21-327361462-2153776455-382321960-500","directoryContext":{"identityProvider":"AzureAD","tenantId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6f","idpInstanceId":"72575eef-3be0-459a-bd36-c15b524924c4"},"name":"users","type":"User","description":"This is a test user","siteId":1,"enabled":true,"priority":100}},"ExportModel":{"description":"A file of the file repository, or a backup of a configuration set or its settings","type":"object","properties":{"path":{"description":"Full path of the file. Specify this value when deleting the file","type":"string"},"name":{"description":"Name of the file as displayed in the console","type":"string"},"extra":{"description":"Metadata stored with the file. Populated only when the metadata is requested","type":"object"},"lastModified":{"description":"Date and time when the file was last modified","type":"string"},"size":{"format":"int64","description":"Size of the file in bytes","type":"integer"},"source":{"description":"Feature that produced the file, for example a scripted task, a report, or a backup","enum":["Unknown","ScriptedTask","ReportExport","AgentExport","UserExport","AdministrativeLogExport","GPOTemplate","SiteExport","SiteAutoExport","SettingsExport"],"type":"string"},"fileType":{"description":"Type of content, for example CSV or JSON, or the file name extension","type":"string"},"deletable":{"description":"Whether the file can be deleted","type":"boolean"}},"example":{"path":"path/to/exported.zip","name":"exported","extra":{"file":["file1.xml","file2.xml"],"actions":[{"type":"VUEMActionGroups","name":"MyActionGroup","id":1},{"type":"VUEMActions","name":"MyAction","id":2}]},"size":0,"source":"Unknown","deletable":false}},"StringListModel":{"type":"object","properties":{"stringList":{"type":"array","items":{"type":"string"}}},"example":{"stringList":["item1","item2"]}},"SiteModel":{"description":"Model of Site","type":"object","properties":{"id":{"format":"int64","description":"Identity of site","type":"integer","readOnly":true},"name":{"description":"Name of site","type":"string"},"description":{"description":"Description of site","type":"string"},"properties":{"description":"Property of site","type":"object","readOnly":true},"scopeUid":{"description":"RBAC scope Uid","type":"string"}},"example":{"id":2,"name":"New Site","description":"This is a site for test","scopeUid":"6240f4db-726f-42dc-8547-387620da0042"}},"MachineModel":{"description":"Model of machine-level AD object","required":["name","siteId"],"type":"object","properties":{"id":{"format":"int64","description":"Identity of machine-level AD object","type":"integer","readOnly":true},"sid":{"description":"SID of machine-level AD object","type":"string","readOnly":true},"name":{"description":"Distinguished name of machine-level AD object","type":"string"},"type":{"description":"Type of machine-level AD object","enum":["None","Group","Computer","OU","Catalog","FMANonDomainJoinedComputer"],"type":"string","readOnly":true},"description":{"description":"Description of machine-level AD object","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this machine-level AD object belongs","type":"integer"},"enabled":{"description":"If this machine-level AD object is enabled","type":"boolean"},"priority":{"format":"int64","description":"Priority of machine-level AD object","type":"integer"},"directoryContext":{"$ref":"#/definitions/DirectoryContextModel"}},"example":{"id":3,"sid":"S-1-5-21-1375803180-495861276-740282956-1114","name":"CN=TestComputer,CN=Computers,DC=bvt,DC=local","type":"Computer","description":"This is a test computer","siteId":1,"enabled":true,"priority":100}},"EnvironmentVariableActionModel":{"description":"Model of Environment Variable Action","required":["variableName","name"],"type":"object","properties":{"actionType":{"description":"Environment Variable type","enum":["CreateSetEnvironmentVariable"],"type":"string"},"enabled":{"description":"State of Environment Variable","type":"boolean"},"variableName":{"description":"Variable Name of Environment Variable","type":"string"},"variableValue":{"description":"Variable Value of Environment Variable","type":"string"},"executionOrder":{"format":"int32","description":"Execution Order of Environment Variable","type":"integer"},"assignmentCount":{"format":"int64","description":"Whether environment variable gets AssignmentCount","type":"integer","readOnly":true},"id":{"format":"int64","description":"Identity of this resource","type":"integer","readOnly":true},"name":{"description":"Display name of this resource","type":"string"},"description":{"description":"Description of this resource","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this resource belongs","type":"integer","readOnly":true},"revision":{"format":"int64","description":"The revision number of this resource","type":"integer","readOnly":true}},"example":{"actionType":"CreateSetEnvironmentVariable","enabled":true,"variableName":"tempvariable","variableValue":"c:\\temp","executionOrder":0,"assignmentCount":0,"id":1,"name":"env1","description":"env1","siteId":1,"revision":0}},"DirectoryContext":{"type":"object","properties":{"forest":{"type":"string"},"domain":{"type":"string"},"tenantId":{"type":"string"},"idpInstanceId":{"type":"string"}}},"GroupPolicyRegistryOperationModel":{"description":"Model of group policy object registry operation","required":["action","scope"],"type":"object","properties":{"action":{"description":"The action of registry operation.","enum":["SetValue","DeleteValue","CreateKey","DeleteKey","DeleteAllValues"],"type":"string"},"scope":{"description":"The scope of registry operation.","enum":["Machine","User"],"type":"string"},"key":{"description":"The key of registry operation.","type":"string"},"value":{"description":"The value of registry operation.","type":"string"},"regType":{"description":"The type of registry operation.","enum":["REG_SZ","REG_EXPAND_SZ","REG_BINARY","REG_DWORD","REG_DWORD_LITTLE_ENDIAN","REG_QWORD","REG_QWORD_LITTLE_ENDIAN","REG_MULTI_SZ","REG_NONE"],"type":"string"},"regData":{"description":"The data of registry operation.","type":"object"},"policyDefinition":{"description":"The policy definition of registry operation.","type":"string"},"directoryContextValue":{"$ref":"#/definitions/DirectoryContext"}}},"GroupPolicyObjectModel":{"description":"Model of group policy object","required":["name"],"type":"object","properties":{"guid":{"description":"Guid of the group policy object","type":"string","readOnly":true},"createdTime":{"description":"The created time of group policy object","type":"string","readOnly":true},"modifiedTime":{"description":"The modified time of group policy object","type":"string","readOnly":true},"enabled":{"description":"The state of group policy object","type":"boolean"},"isFromTemplate":{"description":"The type of group policy object","type":"boolean"},"isUpmUserLevelSettings":{"description":"Whether the group policy object is specific for UPM user level settings","type":"boolean"},"isUpmFolderRedirectionSettings":{"description":"Whether the group policy object is specific for UPM folder redirection settings","type":"boolean"},"isEnvironmentalSettings":{"description":"Whether the group policy object is specific for Environmental Settings","type":"boolean"},"registryOperations":{"description":"The registry operations contained in a group policy object","type":"array","items":{"$ref":"#/definitions/GroupPolicyRegistryOperationModel"}},"assignmentCount":{"format":"int64","description":"Whether group policy object gets AssignmentCount","type":"integer","readOnly":true},"regOperationCount":{"format":"int64","description":"Whether group policy object gets RegOperationCount","type":"integer","readOnly":true},"id":{"format":"int64","description":"Identity of this resource","type":"integer","readOnly":true},"name":{"description":"Display name of this resource","type":"string"},"description":{"description":"Description of this resource","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this resource belongs","type":"integer","readOnly":true},"revision":{"format":"int64","description":"The revision number of this resource","type":"integer","readOnly":true}},"example":{"guid":"11f52b98-008b-4828-8767-9056ac321838","createdTime":"0001-01-01T00:00:00","modifiedTime":"0001-01-01T00:00:00","enabled":true,"isFromTemplate":false,"isUpmUserLevelSettings":false,"isUpmFolderRedirectionSettings":false,"isEnvironmentalSettings":false,"registryOperations":[{"action":"SetValue","scope":"Machine","key":"key","value":"test","regType":"REG_SZ","regData":"5"}],"assignmentCount":0,"regOperationCount":0,"id":1,"name":"gpo","description":"Description example","siteId":1,"revision":0}},"NetworkDriveModel":{"description":"Model of network drive object","required":["name"],"type":"object","properties":{"actionType":{"description":"Network drive type","enum":["MapNetworkDrive"],"type":"string"},"enabled":{"description":"Network drive state","type":"boolean"},"targetPath":{"description":"Target Network drive path","type":"string"},"useCredential":{"description":"Connect to Network drive using credentials","type":"boolean"},"userName":{"description":"User name","type":"string"},"password":{"description":"Password","type":"string"},"displayName":{"description":"Network drive display name","type":"string"},"selfHealing":{"description":"Enable automatic restore of network drive","type":"boolean"},"setAsHomeDrive":{"description":"Enable set as home drive of network drive","type":"boolean"},"assignmentCount":{"format":"int64","description":"Whether network drive gets AssignmentCount","type":"integer","readOnly":true},"id":{"format":"int64","description":"Identity of this resource","type":"integer","readOnly":true},"name":{"description":"Display name of this resource","type":"string"},"description":{"description":"Description of this resource","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this resource belongs","type":"integer","readOnly":true},"revision":{"format":"int64","description":"The revision number of this resource","type":"integer","readOnly":true}},"example":{"actionType":"MapNetworkDrive","enabled":true,"targetPath":"targetpath","useCredential":true,"userName":"username","password":"password","displayName":"Network drive display example","selfHealing":false,"setAsHomeDrive":false,"assignmentCount":0,"id":1,"name":"Network drive example","description":"Description example","siteId":1,"revision":0}},"PrinterModel":{"description":"Model of Printer object","required":["name"],"type":"object","properties":{"actionType":{"description":"Printer type","enum":["NetWorkPrinter","DeviceMappingPrinter"],"type":"string"},"enabled":{"description":"Printer state","type":"boolean"},"targetPath":{"description":"Target printer path","type":"string"},"useCredential":{"description":"Connect to printer using credentials","type":"boolean"},"userName":{"description":"User name","type":"string"},"password":{"description":"Password","type":"string"},"displayName":{"description":"Printer display name","type":"string"},"selfHealing":{"description":"Enable automatic restore of printer","type":"boolean"},"assignmentCount":{"format":"int64","description":"Whether printer gets AssignmentCount","type":"integer","readOnly":true},"id":{"format":"int64","description":"Identity of this resource","type":"integer","readOnly":true},"name":{"description":"Display name of this resource","type":"string"},"description":{"description":"Description of this resource","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this resource belongs","type":"integer","readOnly":true},"revision":{"format":"int64","description":"The revision number of this resource","type":"integer","readOnly":true}},"example":{"actionType":"NetWorkPrinter","enabled":true,"targetPath":"targetpath","useCredential":true,"userName":"username","password":"password","displayName":"Printer display example","selfHealing":false,"assignmentCount":0,"id":1,"name":"Printer example","description":"Description example","siteId":1,"revision":0}},"RegistryEntryActionModel":{"description":"Model of Registry Entry Action","required":["enabled","targetPath","targetName","name"],"type":"object","properties":{"enabled":{"description":"State of Registry Entry","type":"boolean"},"targetPath":{"description":"TargetPath of Registry Entry","type":"string"},"targetName":{"description":"TargetName of Registry Entry","type":"string"},"targetType":{"description":"TargetType of Registry Entry","enum":["REG_DWORD","REG_SZ","REG_EXPAND_SZ","REG_BINARY","REG_MULTI_SZ","REG_NONE"],"type":"string"},"targetValue":{"description":"TargetValue of Registry Entry","type":"string"},"runOnce":{"description":"RunOnce of Registry Entry","type":"boolean"},"actionType":{"description":"ActionType of Registry Entry","enum":["Create","Delete"],"type":"string"},"tags":{"description":"Tags of Registry Entry","type":"array","items":{"type":"string"}},"assignmentCount":{"format":"int64","description":"Whether registry entry gets AssignmentCount","type":"integer","readOnly":true},"id":{"format":"int64","description":"Identity of this resource","type":"integer","readOnly":true},"name":{"description":"Display name of this resource","type":"string"},"description":{"description":"Description of this resource","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this resource belongs","type":"integer","readOnly":true},"revision":{"format":"int64","description":"The revision number of this resource","type":"integer","readOnly":true}},"example":{"enabled":true,"targetPath":"Software","targetName":"RegTest","targetType":"REG_SZ","targetValue":"TestValue","runOnce":true,"actionType":"Create","tags":["tag1","tag2"],"assignmentCount":1,"id":1,"name":"My registry entry","description":"This is a registry entry for test","siteId":1,"revision":0}},"ProcessMemoryLimit":{"type":"object","properties":{"processName":{"type":"string"},"memoryLimit":{"format":"int32","type":"integer"},"limitType":{"enum":["Dynamic","Static"],"type":"string"}}},"ProcessCpuPriority":{"type":"object","properties":{"processName":{"type":"string"},"priority":{"enum":["Idle","BelowNormal","Normal","AboveNormal","High","Realtime"],"type":"string"}}},"ProcessAffinity":{"type":"object","properties":{"processName":{"type":"string"},"affinity":{"format":"int32","type":"integer"}}},"ProcessClamping":{"type":"object","properties":{"processName":{"type":"string"},"percentage":{"format":"int32","type":"integer"}}},"ProcessIoPriority":{"type":"object","properties":{"processName":{"type":"string"},"priority":{"enum":["VeryLow","Low","Normal","High"],"type":"string"}}},"SystemOptimizationModel":{"type":"object","properties":{"id":{"format":"int64","description":"Identity of this system optimization model and the identity of the site to which this configuration applies","type":"integer","readOnly":true},"enableCpuSpikeProtection":{"description":"Lets you lower the CPU priority of processes that overload your CPU","type":"boolean"},"enableCpuAutoProtection":{"description":"Lets you lower the CPU priority of processes automatically","type":"boolean"},"cpuUsageLimitOfSpikeProtection":{"format":"float","description":"CPU usage limit (%) for CPU spike protection","type":"number"},"cpuUsageLimitSampleTimeOfSpikeProtection":{"format":"int32","description":"Limit sample time (s) for CPU spike protection","type":"integer"},"idlePriorityTimeOfSpikeProtection":{"format":"int32","description":"Idle priority time (s) for CPU spike protection","type":"integer"},"enablePerCoreCpuUsageLimit":{"description":"Enable CPU usage limit (%) relative to a single CPU core for CPU spike protection","type":"boolean"},"perCoreCpuUsageLimitOfSpikeProtection":{"format":"float","description":"CPU usage limit (%) relative to a single CPU core for CPU spike protection","type":"number"},"enableLimitCpuCoreUsage":{"description":"Lets you limit processes that trigger CPU spike protection to a specified number of logical processors","type":"boolean"},"cpuCoreLimitOfSpikeProtection":{"format":"int32","description":"CPU core usage limit","type":"integer"},"enableIntelligentCpuOptimization":{"description":"Enable agent to intelligently optimize the CPU priority of processes that trigger CPU spike protection","type":"boolean"},"enableIntelligentIoOptimization":{"description":"Enable agent to intelligently optimize the I/O priority of processes that trigger CPU spike protection","type":"boolean"},"excludeProcessesFromCpuSpikeProtection":{"description":"Lets you add or remove processes from an exclusion list for CPU spike protection by executable name","type":"boolean"},"processesExcludedFromCpuSpikeProtection":{"description":"Processes excluded from CPU spike protection","type":"array","items":{"type":"string"}},"enableMemoryOptimizationThreshold":{"description":"Lets you specify the min available memory when performing an optimization","type":"boolean"},"memoryOptimizationThreshold":{"format":"int32","description":"The min available memory (MB) when performing an optimization","type":"integer"},"enableProcessMemoryLimit":{"description":"Lets you limit the memory usage of specified processes","type":"boolean"},"processesOfMemoryLimit":{"description":"Processes whose memory usage is limited","type":"array","items":{"$ref":"#/definitions/ProcessMemoryLimit"}},"enableProcessCpuPriority":{"description":"Lets you configure process CPU priority manually","type":"boolean"},"processesOfCpuPriority":{"description":"CPU priorities specified for the processes","type":"array","items":{"$ref":"#/definitions/ProcessCpuPriority"}},"enableProcessAffinity":{"description":"Lets you define how many \"logical processors\" for a process to use","type":"boolean"},"processesOfCpuAffinity":{"description":"Logical processors specified for the processes","type":"array","items":{"$ref":"#/definitions/ProcessAffinity"}},"enableProcessClamping":{"description":"Lets you prevent processes using more than a certain percentage of the CPU's processing power","type":"boolean"},"processesOfCpuClamping":{"description":"CPU clamping (%) specified for the processes","type":"array","items":{"$ref":"#/definitions/ProcessClamping"}},"enableMemoryWorkingSetOptimization":{"description":"Lets you force applications that have been idle for a certain time to release excess memory until they are no longer idle","type":"boolean"},"idleSampleTimeOfMemoryWorkingSetOptimization":{"format":"int32","description":"Time (min) for which an application must be idle before it is forced to release excess memory","type":"integer"},"idleStateLimitOfMemoryWorkingSetOptimization":{"format":"int32","description":"CPU usage (%) under which a process is considered to be idle","type":"integer"},"excludeProcessesFromMemoryWorkingSetOptimization":{"description":"Lets you exclude processes from memory management by name","type":"boolean"},"processesExcludedFromMemoryWorkingSetOptimization":{"description":"Processes excluded from working set optimization","type":"array","items":{"type":"string"}},"enableProcessIoPriority":{"description":"Lets you configure process I/O priority manually","type":"boolean"},"processesOfIoPriority":{"description":"I/O priorities specified for the processes","type":"array","items":{"$ref":"#/definitions/ProcessIoPriority"}},"enableFastLogoff":{"description":"Enables fast logoff for all users in this configuration set","type":"boolean"},"excludeGroupsFromFastLogoff":{"description":"Lets you exclude specific groups of users from Fast Logoff","type":"boolean"},"groupsExcludedFromFastLogoff":{"description":"The groups you exclude from Fast Logoff","type":"array","items":{"type":"string"}},"groupsExcludedFromFastLogoffDirectoryContext":{"description":"Groups excluded from fast logoff directory context","type":"array","items":{"$ref":"#/definitions/DirectoryContext"}},"disableProcessPriorityInheritance":{"description":"Lets you prevent child processes from inheriting CPU priority","type":"boolean"},"parentProcessesToDisablePriorityInheritance":{"description":"Specify processes whose child processes you do not want to inherit the CPU priority.","type":"array","items":{"type":"string"}},"parentProcessesToDisablePriorityInheritanceDirectoryContext":{"description":"Parent processes to disable priority inheritance directory context","type":"array","items":{"$ref":"#/definitions/DirectoryContext"}}},"example":{"id":1,"enableCpuSpikeProtection":true,"enableCpuAutoProtection":false,"cpuUsageLimitOfSpikeProtection":70.0,"cpuUsageLimitSampleTimeOfSpikeProtection":30,"idlePriorityTimeOfSpikeProtection":180,"enablePerCoreCpuUsageLimit":true,"perCoreCpuUsageLimitOfSpikeProtection":80.0,"enableLimitCpuCoreUsage":false,"cpuCoreLimitOfSpikeProtection":1,"enableIntelligentCpuOptimization":true,"enableIntelligentIoOptimization":true,"excludeProcessesFromCpuSpikeProtection":true,"processesExcludedFromCpuSpikeProtection":["excluded-process-name-1","excluded-process-name-2"],"enableMemoryOptimizationThreshold":true,"memoryOptimizationThreshold":1024,"enableProcessMemoryLimit":true,"processesOfMemoryLimit":[{"processName":"chrome","memoryLimit":512,"limitType":"Dynamic"}],"enableProcessCpuPriority":true,"processesOfCpuPriority":[{"processName":"cpu-process-1","priority":"High"},{"processName":"cpu-process-2","priority":"Normal"},{"processName":"cpu-process-3","priority":"BelowNormal"},{"processName":"cpu-process-4","priority":"Realtime"}],"enableProcessAffinity":true,"processesOfCpuAffinity":[{"processName":"affinity-process-1","affinity":16},{"processName":"affinity-process-2","affinity":32}],"enableProcessClamping":true,"processesOfCpuClamping":[{"processName":"clamping-process-1","percentage":12},{"processName":"clamping-process-2","percentage":60}],"enableMemoryWorkingSetOptimization":true,"idleSampleTimeOfMemoryWorkingSetOptimization":120,"idleStateLimitOfMemoryWorkingSetOptimization":1,"excludeProcessesFromMemoryWorkingSetOptimization":true,"processesExcludedFromMemoryWorkingSetOptimization":["excluded-process-name-1","excluded-process-name-2"],"enableProcessIoPriority":true,"processesOfIoPriority":[{"processName":"io-process-1","priority":"High"},{"processName":"io-process-2","priority":"Normal"},{"processName":"io-process-3","priority":"VeryLow"}],"enableFastLogoff":true,"excludeGroupsFromFastLogoff":true,"groupsExcludedFromFastLogoff":["CN=Domain Guests,CN=Users,DC=bvt,DC=local","CN=Domain Admins,CN=Users,DC=bvt,DC=local","OID:/azuread/1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6f"],"groupsExcludedFromFastLogoffDirectoryContext":[{"identityProvider":"AD","forest":"corp.example.com","domain":"example"},{"identityProvider":"AD","forest":"corp.example.com","domain":"example"},{"identityProvider":"AzureAD","domain":"azureexample","tenantId":"12345678-90ab-cdef-1234-567890abcdef","idpInstanceId":"aad-instance-001"}],"disableProcessPriorityInheritance":true,"parentProcessesToDisablePriorityInheritance":["excluded-process-name-1","excluded-process-name-2"],"parentProcessesToDisablePriorityInheritanceDirectoryContext":[{"identityProvider":"AD","forest":"corp.example.com","domain":"example"},{"identityProvider":"AzureAD","domain":"azureexample","tenantId":"12345678-90ab-cdef-1234-567890abcdef","idpInstanceId":"aad-instance-001"}]}},"VirtualDriveModel":{"description":"Model of Virtual Drive","required":["name"],"type":"object","properties":{"enabled":{"description":"State of Virtual Drive","type":"boolean"},"actionType":{"description":"Action type of Virtual Drive","enum":["MapVirtualDrive"],"type":"string"},"targetPath":{"description":"Target path of Virtual Drive","type":"string"},"setAsHomeDrive":{"description":"Enable Setting As Home Drive or not","type":"boolean"},"assignmentCount":{"format":"int64","description":"Whether virtual drive gets AssignmentCount","type":"integer","readOnly":true},"id":{"format":"int64","description":"Identity of this resource","type":"integer","readOnly":true},"name":{"description":"Display name of this resource","type":"string"},"description":{"description":"Description of this resource","type":"string"},"siteId":{"format":"int64","description":"Identity of site to which this resource belongs","type":"integer","readOnly":true},"revision":{"format":"int64","description":"The revision number of this resource","type":"integer","readOnly":true}},"example":{"enabled":true,"actionType":"MapVirtualDrive","targetPath":"c:\\test","setAsHomeDrive":false,"assignmentCount":0,"id":1,"name":"Virtual Drive example","description":"Virtual Drive Description example","siteId":1,"revision":0}},"RestError":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/invalidJson","detail":"Unable to parse the format of request body as a json object","parameters":[{"name":"reason","value":"format error"}]}},"RestError_BadRequest":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/invalidJson","detail":"Unable to parse the format of request body as a json object","parameters":[{"name":"reason","value":"format error"}]}},"RestError_Unauthorized":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/authentication","detail":"Missing or invalid authentication details","parameters":[{"name":"reason","value":"missing"}]}},"RestError_Forbidden":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/forbidden","detail":"Not allowed to delete","parameters":[{"name":"id","value":"1"}]}},"RestError_NotFound":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/notFound","detail":"Cannot find target resource","parameters":[{"name":"property","value":"id"}]}},"RestError_NotAcceptable":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/notAcceptable","detail":"Must accept application/json media type","parameters":[{"name":"contentType","value":"application/json"}]}},"RestError_Conflict":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/optimisticConcurrency","detail":"Entity is being used or depended by other existing resource","parameters":[{"name":"entityType","value":"AssignedActions"}]}},"RestError_UnsupportedMediaType":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"parameters":{"type":"array","items":{"type":"object"}}},"example":{"type":"https://errors-api.cloud.com/common/unsupportedMediaType","detail":"Must use application/json;charset=utf-8 media type","parameters":[{"name":"mediaType","value":"application/xml"}]}}},"parameters":{"Accept":{"name":"Accept","in":"header","description":"Only \"application/json\" is supported.","required":true,"type":"string","default":"application/json"},"Authorization":{"name":"Authorization","in":"header","description":"Citrix Cloud authorization token.","required":true,"type":"string"},"CitrixTransactionId":{"name":"Citrix-TransactionId","in":"header","description":"Transaction ID that will be used to track this request.","required":false,"type":"string"},"CitrixCustomerId":{"name":"Citrix-CustomerId","in":"header","description":"Citrix Cloud customer ID.","required":true,"type":"string"}},"responses":{"404":{"description":"The target resource cannot be found.","schema":{"$ref":"#/definitions/RestError_NotFound"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"201":{"description":"Resource creation completed successfully.","headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"},"Location":{"description":"Location of the created resource.","type":"string"}}},"204":{"description":"Resource update completed successfully.","headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"400":{"description":"The format of the parameters is incorrect.","schema":{"$ref":"#/definitions/RestError_BadRequest"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"409":{"description":"A resource with the same identity already exists.","schema":{"$ref":"#/definitions/RestError_Conflict"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"401":{"description":"Authorization failed.","schema":{"$ref":"#/definitions/RestError_Unauthorized"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"403":{"description":"Access denied.","schema":{"$ref":"#/definitions/RestError_Forbidden"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"415":{"description":"The charset is not supported.","schema":{"$ref":"#/definitions/RestError_UnsupportedMediaType"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}},"406":{"description":"Requested media type is not supported.","schema":{"$ref":"#/definitions/RestError_NotAcceptable"},"headers":{"Citrix-TransactionId":{"description":"Transaction ID that will be used to track this request.","type":"string"}}}},"securityDefinitions":{"basic":{"type":"basic"}},"security":[{"basic":[]}]}