{ "openapi": "3.0.4", "info": { "title": "Citrix.CloudServices.Registry.Api", "version": "v1" }, "paths": { "/{customer}/changeevents": { "post": { "tags": [ "ChangeEvents" ], "summary": "Posts a change event notification. [ServiceKey]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The change event model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.ChangeEventsModel" }, "example": "{\r\n \"afterChange\": null,\r\n \"beforeChange\": null,\r\n \"changeType\": \"Update\",\r\n \"customerId\": \"customer1\",\r\n \"geo\": \"EastUS\",\r\n \"identifier\": \"123234\",\r\n \"resourceProvider\": \"XenDesktop\",\r\n \"service\": \"XenDesktop\",\r\n \"timeStamp\": \"1970-01-01T00:00:00Z\",\r\n \"transactionId\": \"456235435\",\r\n \"type\": \"FeedsChange\",\r\n \"userId\": \"ee270a14-f8d7-4725-b545-d64f32cd5d45\",\r\n \"userPrincipal\": \"someuser@example.com\",\r\n \"systemLogCorrelationId\": null,\r\n \"oid\": \"5f7a2a4a-ecb0-430f-b0a0-7583f43525ac\",\r\n \"email\": \"mike@gmail.com\",\r\n \"displayName\": \"mike\",\r\n \"sid\": \"S-1-5-21-3625534769-2744235003-4104900556-513\",\r\n \"upn\": \"User1@xd.local\",\r\n \"groups\": [\r\n \"admin-group-1\",\r\n \"admin-group-2\"\r\n ]\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.ChangeEventsModel" }, "example": "{\r\n \"afterChange\": null,\r\n \"beforeChange\": null,\r\n \"changeType\": \"Update\",\r\n \"customerId\": \"customer1\",\r\n \"geo\": \"EastUS\",\r\n \"identifier\": \"123234\",\r\n \"resourceProvider\": \"XenDesktop\",\r\n \"service\": \"XenDesktop\",\r\n \"timeStamp\": \"1970-01-01T00:00:00Z\",\r\n \"transactionId\": \"456235435\",\r\n \"type\": \"FeedsChange\",\r\n \"userId\": \"ee270a14-f8d7-4725-b545-d64f32cd5d45\",\r\n \"userPrincipal\": \"someuser@example.com\",\r\n \"systemLogCorrelationId\": null,\r\n \"oid\": \"5f7a2a4a-ecb0-430f-b0a0-7583f43525ac\",\r\n \"email\": \"mike@gmail.com\",\r\n \"displayName\": \"mike\",\r\n \"sid\": \"S-1-5-21-3625534769-2744235003-4104900556-513\",\r\n \"upn\": \"User1@xd.local\",\r\n \"groups\": [\r\n \"admin-group-1\",\r\n \"admin-group-2\"\r\n ]\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.ChangeEventsModel" }, "example": "{\r\n \"afterChange\": null,\r\n \"beforeChange\": null,\r\n \"changeType\": \"Update\",\r\n \"customerId\": \"customer1\",\r\n \"geo\": \"EastUS\",\r\n \"identifier\": \"123234\",\r\n \"resourceProvider\": \"XenDesktop\",\r\n \"service\": \"XenDesktop\",\r\n \"timeStamp\": \"1970-01-01T00:00:00Z\",\r\n \"transactionId\": \"456235435\",\r\n \"type\": \"FeedsChange\",\r\n \"userId\": \"ee270a14-f8d7-4725-b545-d64f32cd5d45\",\r\n \"userPrincipal\": \"someuser@example.com\",\r\n \"systemLogCorrelationId\": null,\r\n \"oid\": \"5f7a2a4a-ecb0-430f-b0a0-7583f43525ac\",\r\n \"email\": \"mike@gmail.com\",\r\n \"displayName\": \"mike\",\r\n \"sid\": \"S-1-5-21-3625534769-2744235003-4104900556-513\",\r\n \"upn\": \"User1@xd.local\",\r\n \"groups\": [\r\n \"admin-group-1\",\r\n \"admin-group-2\"\r\n ]\r\n}" } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/changeevents/subscription/{id}": { "put": { "tags": [ "ChangeEvents" ], "summary": "Update Change Events Subscription [ServiceKey]", "parameters": [ { "name": "id", "in": "path", "description": "The subscription id.", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The update model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateModel" }, "example": "{\r\n \"customerFilter\": \"acme\",\r\n \"customerGeoFilter\": \"US\",\r\n \"objecTypeFilter\": \"Administrator\",\r\n \"changeTypeFilter\": \"Create\",\r\n \"serviceProfileFilter\": \"fakesp\",\r\n \"serviceProfileChangeEventsSubscription\": \"fakesp\",\r\n \"callerServiceIdentityFilter\": \"fakesp\",\r\n \"geoFilter\": \"US\",\r\n \"resourceProviderFilter\": \"XenMobile\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateModel" }, "example": "{\r\n \"customerFilter\": \"acme\",\r\n \"customerGeoFilter\": \"US\",\r\n \"objecTypeFilter\": \"Administrator\",\r\n \"changeTypeFilter\": \"Create\",\r\n \"serviceProfileFilter\": \"fakesp\",\r\n \"serviceProfileChangeEventsSubscription\": \"fakesp\",\r\n \"callerServiceIdentityFilter\": \"fakesp\",\r\n \"geoFilter\": \"US\",\r\n \"resourceProviderFilter\": \"XenMobile\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateModel" }, "example": "{\r\n \"customerFilter\": \"acme\",\r\n \"customerGeoFilter\": \"US\",\r\n \"objecTypeFilter\": \"Administrator\",\r\n \"changeTypeFilter\": \"Create\",\r\n \"serviceProfileFilter\": \"fakesp\",\r\n \"serviceProfileChangeEventsSubscription\": \"fakesp\",\r\n \"callerServiceIdentityFilter\": \"fakesp\",\r\n \"geoFilter\": \"US\",\r\n \"resourceProviderFilter\": \"XenMobile\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "get": { "tags": [ "ChangeEvents" ], "summary": "Get Change Events Subscription [ServiceKey]", "parameters": [ { "name": "id", "in": "path", "description": "The subscription id.", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "ChangeEvents" ], "summary": "Delete Change Events Subscription [ServiceKey]", "parameters": [ { "name": "id", "in": "path", "description": "The subscription id.", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/changeevents/subscription/{id}/state": { "put": { "tags": [ "ChangeEvents" ], "summary": "Set Change Events Subscription State [ServiceKey]", "parameters": [ { "name": "id", "in": "path", "description": "The subscription id.", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The update state model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateStateModel" }, "example": "{\r\n \"disabled\": true\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateStateModel" }, "example": "{\r\n \"disabled\": true\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateStateModel" }, "example": "{\r\n \"disabled\": true\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/changeevents/subscription": { "post": { "tags": [ "ChangeEvents" ], "summary": "Create Change Events Subscription [ServiceKey]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The create model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionCreateModel" }, "example": "{\r\n \"name\": \"testSub\",\r\n \"recommendedGuid\": null,\r\n \"cryptoRandomId\": null,\r\n \"contactEmail\": null,\r\n \"customerFilter\": \"acme\",\r\n \"customerGeoFilter\": \"US\",\r\n \"objecTypeFilter\": \"Administrator\",\r\n \"changeTypeFilter\": \"Create\",\r\n \"serviceProfileFilter\": \"fakesp\",\r\n \"serviceProfileChangeEventsSubscription\": \"fakesp\",\r\n \"callerServiceIdentityFilter\": \"fakesp\",\r\n \"geoFilter\": \"US\",\r\n \"resourceProviderFilter\": \"XenMobile\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionCreateModel" }, "example": "{\r\n \"name\": \"testSub\",\r\n \"recommendedGuid\": null,\r\n \"cryptoRandomId\": null,\r\n \"contactEmail\": null,\r\n \"customerFilter\": \"acme\",\r\n \"customerGeoFilter\": \"US\",\r\n \"objecTypeFilter\": \"Administrator\",\r\n \"changeTypeFilter\": \"Create\",\r\n \"serviceProfileFilter\": \"fakesp\",\r\n \"serviceProfileChangeEventsSubscription\": \"fakesp\",\r\n \"callerServiceIdentityFilter\": \"fakesp\",\r\n \"geoFilter\": \"US\",\r\n \"resourceProviderFilter\": \"XenMobile\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionCreateModel" }, "example": "{\r\n \"name\": \"testSub\",\r\n \"recommendedGuid\": null,\r\n \"cryptoRandomId\": null,\r\n \"contactEmail\": null,\r\n \"customerFilter\": \"acme\",\r\n \"customerGeoFilter\": \"US\",\r\n \"objecTypeFilter\": \"Administrator\",\r\n \"changeTypeFilter\": \"Create\",\r\n \"serviceProfileFilter\": \"fakesp\",\r\n \"serviceProfileChangeEventsSubscription\": \"fakesp\",\r\n \"callerServiceIdentityFilter\": \"fakesp\",\r\n \"geoFilter\": \"US\",\r\n \"resourceProviderFilter\": \"XenMobile\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/changeevents/subscription/exists/{id}": { "get": { "tags": [ "ChangeEvents" ], "summary": "Check whether subscription exists or not. [ServiceKey]", "parameters": [ { "name": "id", "in": "path", "description": "The subscription id.", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/changeevents/objecttypes": { "get": { "tags": [ "ChangeEvents" ], "summary": "Get a list of the available object types. [ServiceKey]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.ChangeEventsObjectTypesResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.ChangeEventsObjectTypesResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.ChangeEventsObjectTypesResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/Customers": { "post": { "tags": [ "Customers" ], "summary": "Saves a new customer and enables Canary support. [ServiceKey][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } }, "application/*+json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "Customers" ], "summary": "Removes Canary support for a customer. [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "query", "description": "The ID of the customer to delete.", "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/Customers/{id}": { "delete": { "tags": [ "Customers" ], "summary": "Removes Canary support for a customer. [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the customer to delete.", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/customertermsofservice": { "post": { "tags": [ "CustomerTermsOfService" ], "summary": "Create terms of service agreement info for a customer. If it already exists, return 409. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" }, "example": "{\r\n \"resellerId\": \"root\",\r\n \"version\": \"1.1\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" }, "example": "{\r\n \"resellerId\": \"root\",\r\n \"version\": \"1.1\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" }, "example": "{\r\n \"resellerId\": \"root\",\r\n \"version\": \"1.1\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "get": { "tags": [ "CustomerTermsOfService" ], "summary": "Get terms of service for a customer. Returns null if customer has already agreed to the latest terms. [ServiceKey][BearerToken]", "parameters": [ { "name": "reseller", "in": "query", "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "put": { "tags": [ "CustomerTermsOfService" ], "summary": "Set terms of service agreement info for a customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" }, "example": "{\r\n \"resellerId\": \"root\",\r\n \"version\": \"1.1\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" }, "example": "{\r\n \"resellerId\": \"root\",\r\n \"version\": \"1.1\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" }, "example": "{\r\n \"resellerId\": \"root\",\r\n \"version\": \"1.1\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "delete": { "tags": [ "CustomerTermsOfService" ], "summary": "Delete terms of service agreement info for a customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "reseller", "in": "query", "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/customertermsofservice/{reseller}": { "get": { "tags": [ "CustomerTermsOfService" ], "summary": "Get terms of service for a customer. Returns null if customer has already agreed to the latest terms. [ServiceKey][BearerToken]", "parameters": [ { "name": "reseller", "in": "path", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "delete": { "tags": [ "CustomerTermsOfService" ], "summary": "Delete terms of service agreement info for a customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "reseller", "in": "path", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/mastertermsofservice": { "get": { "tags": [ "CustomerTermsOfService" ], "summary": "Get master terms of service for the platform. [Public]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel" } } } } } } }, "/{customer}/dataschema": { "get": { "tags": [ "DataSchema" ], "summary": "Gets a the highest supported data schema for this service. [ServiceKey][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.DataSchemaModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.DataSchemaModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.DataSchemaModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "DataSchema" ], "summary": "Resets the data schema migration. [ServiceKey][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/edgeproxy": { "post": { "tags": [ "EdgeProxy" ], "summary": "Creates or updates the protocol proxy configuration for a customer. [ServiceKey]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The endpoints the proxy should handle.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.Api.EdgeProxy.EdgeProxyEndpoint" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.Api.EdgeProxy.EdgeProxyEndpoint" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.Api.EdgeProxy.EdgeProxyEndpoint" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "get": { "tags": [ "EdgeProxy" ], "summary": "Gets the current protocol proxy configuration for a customer. [ServiceKey]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.Api.EdgeProxy.GetEdgeProxyConfigurationResults" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.Api.EdgeProxy.GetEdgeProxyConfigurationResults" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.Api.EdgeProxy.GetEdgeProxyConfigurationResults" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "EdgeProxy" ], "summary": "Deletes a customer's protocol proxy configuration. [ServiceKey]", "parameters": [ { "name": "path", "in": "query", "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/featurecustomer/{id}": { "get": { "tags": [ "FeatureCustomer" ], "summary": "Gets the Feature Customer enablement information. [ServiceKey][BearerToken]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "post": { "tags": [ "FeatureCustomer" ], "summary": "Create Features for customer with the list of features to enable for this customer. [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "FeatureCustomer" ], "summary": "Delete all Features for customer [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/featurecustomer/enabled": { "get": { "tags": [ "FeatureCustomer" ], "summary": "Get all features enabled for a customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/featurecustomer/{id}/{customername}": { "post": { "tags": [ "FeatureCustomer" ], "summary": "Creates a Feature Customer entry in Citrix Workspace Cloud [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "description": "Feature Name.", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customername", "in": "path", "description": "Customer Name that has been onboarded.", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "put": { "tags": [ "FeatureCustomer" ], "summary": "Allows the ability to change the Customer Feature Option and/or Enabled [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customername", "in": "path", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/features/{id}": { "get": { "tags": [ "Features" ], "summary": "Gets a specific feature configured. [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "description": "Feature Name.", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "post": { "tags": [ "Features" ], "summary": "Creates a feature. Intitial state for the feature will be disabled for every customer. [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "description": "Feature Name.", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/features": { "get": { "tags": [ "Features" ], "summary": "Gets all the features configured. [ServiceKey][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/features/{id}/{state}": { "put": { "tags": [ "Features" ], "summary": "This API is used to change the State of the feature. [ServiceKey][RootOnly]", "parameters": [ { "name": "id", "in": "path", "description": "Feature Name", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "path", "description": "-2 <= state <= 100", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/features/ResetCache": { "post": { "tags": [ "Features" ], "summary": "Forces the reset of the feature cache. Used to force all customers to retrieve the latest feature states from storage. [BearerToken][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/allresourcelocations": { "get": { "tags": [ "Locations" ], "summary": "Get all resource locations for all customers. [ServiceKey][RootOnly]", "parameters": [ { "name": "take", "in": "query", "description": "The number of results to include in the response. If there are more results, a continuation token will be returned.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "nextToken", "in": "query", "description": "A continuation token from a previous response. All filter criteria from the previous request have to specified again even when passing a continuation token.", "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.DataAccess.Locations.ResourceLocationsQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.DataAccess.Locations.ResourceLocationsQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.DataAccess.Locations.ResourceLocationsQueryResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/resourcelocations": { "get": { "tags": [ "Locations" ], "summary": "Get all resource locations for a customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsResultsModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsResultsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsResultsModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "post": { "tags": [ "Locations" ], "summary": "Create a resource location for a customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The resource location model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" }, "example": "{\r\n \"id\": \"c23d033c-6836-4876-b847-4776cb7727fc\",\r\n \"name\": \"MyResourceLocation\",\r\n \"internalOnly\": false,\r\n \"timeZone\": \"Eastern Standard Time\",\r\n \"readOnly\": false\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" }, "example": "{\r\n \"id\": \"c23d033c-6836-4876-b847-4776cb7727fc\",\r\n \"name\": \"MyResourceLocation\",\r\n \"internalOnly\": false,\r\n \"timeZone\": \"Eastern Standard Time\",\r\n \"readOnly\": false\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" }, "example": "{\r\n \"id\": \"c23d033c-6836-4876-b847-4776cb7727fc\",\r\n \"name\": \"MyResourceLocation\",\r\n \"internalOnly\": false,\r\n \"timeZone\": \"Eastern Standard Time\",\r\n \"readOnly\": false\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/resourcelocations/{id}": { "get": { "tags": [ "Locations" ], "summary": "Get a resource location from id. [ServiceKey][BearerToken]", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "put": { "tags": [ "Locations" ], "summary": "Update the customer resource location information. [ServiceKey][BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The resource location id.", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The resource location model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationUpdateModel" }, "example": "{\r\n \"name\": \"MyResourceLocation\",\r\n \"internalOnly\": false,\r\n \"timeZone\": \"Eastern Standard Time\",\r\n \"readOnly\": false\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationUpdateModel" }, "example": "{\r\n \"name\": \"MyResourceLocation\",\r\n \"internalOnly\": false,\r\n \"timeZone\": \"Eastern Standard Time\",\r\n \"readOnly\": false\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationUpdateModel" }, "example": "{\r\n \"name\": \"MyResourceLocation\",\r\n \"internalOnly\": false,\r\n \"timeZone\": \"Eastern Standard Time\",\r\n \"readOnly\": false\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "delete": { "tags": [ "Locations" ], "summary": "Delete a resource location. [ServiceKey][BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The resource location id.", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/resourcelocationscount": { "get": { "tags": [ "Locations" ], "summary": "Get resource locations count for a customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsCountResultsModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsCountResultsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsCountResultsModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/ping": { "get": { "tags": [ "Ping" ], "summary": "Gets a health check. [Public]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } } } } }, "/{customer}/ping/auth": { "get": { "tags": [ "Ping" ], "summary": "Gets the ping authentication. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } }, { "name": "Citrix-Timeout-ms", "in": "header", "description": "Maximum time caller is willing to wait for a response before timing out the request, in milliseconds", "schema": { "maximum": 300000, "minimum": 100, "type": "number", "default": 60000 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/Preferences/DefaultDomain": { "put": { "tags": [ "Preferences" ], "summary": "Set the default domain to use for customer subscriptions. \r\n**Scope:** Customer [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.DefaultDomain" }, "example": "{\r\n \"domainName\": \"sample.com\",\r\n \"forestName\": \"sample.com\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.DefaultDomain" }, "example": "{\r\n \"domainName\": \"sample.com\",\r\n \"forestName\": \"sample.com\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.DefaultDomain" }, "example": "{\r\n \"domainName\": \"sample.com\",\r\n \"forestName\": \"sample.com\"\r\n}" } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "get": { "tags": [ "Preferences" ], "summary": "Gets the default domain to use for customer subscriptions. \r\n**Scope:** Customer [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.DefaultDomain" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.DefaultDomain" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.DefaultDomain" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "delete": { "tags": [ "Preferences" ], "summary": "Delete the default domain to use for customer subscriptions. \r\n**Scope:** Customer [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/Preferences/Coachmarks/{id}": { "put": { "tags": [ "Preferences" ], "summary": "Set the state of the specified coachmark id. \r\n**Scope:** User [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The coachmark id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "The coachmark state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.Coachmark" }, "example": "{\r\n \"state\": \"Default\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.Coachmark" }, "example": "{\r\n \"state\": \"Default\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.Coachmark" }, "example": "{\r\n \"state\": \"Default\"\r\n}" } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "get": { "tags": [ "Preferences" ], "summary": "Gets the state of the specified coachmark id. \r\n**Scope:** User [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The coachmark id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.Coachmark" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.Coachmark" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.Coachmark" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "Preferences" ], "summary": "Delete the state of the specified coachmark id. \r\n**Scope:** User [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The coachmark id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/Preferences/SkipConfirmationDialog/{id}": { "put": { "tags": [ "Preferences" ], "summary": "Configures setting that indicates whether to skip the confirmation for the specified dialog id.\r\n**Scope:** User [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The dialog id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "get": { "tags": [ "Preferences" ], "summary": "Gets setting that indicates whether to skip the confirmation for the specified dialog id.\r\n**Scope:** User [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The dialog id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "Preferences" ], "summary": "Delete the setting that indicates whether to skip the confirmation for the specified dialog id. \r\n**Scope:** User [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The dialog id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/Preferences/SuppressServiceFtuPulse/{id}": { "put": { "tags": [ "Preferences" ], "summary": "Configures setting that indicates whether to show the pulse animation for the specified service ftu.\r\n**Scope:** Customer [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The service ftu id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "get": { "tags": [ "Preferences" ], "summary": "Gets setting that indicates whether to show the pulse animation for the specified service ftu.\r\n**Scope:** Customer [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The service ftu id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "Preferences" ], "summary": "Delete the setting that indicates whether to show the pulse animation for the specified service ftu. \r\n**Scope:** Customer [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The service ftu id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/Preferences/SuppressFtu/{id}": { "put": { "tags": [ "Preferences" ], "summary": "Configures setting that indicates whether to show the specified page ftu.\r\n**Scope:** Customer [ServiceKey][BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The page ftu id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "get": { "tags": [ "Preferences" ], "summary": "Gets setting that indicates whether to show specified page ftu.\r\n**Scope:** Customer [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The page ftu id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "Preferences" ], "summary": "Delete the setting that indicates whether to show the specified page ftu. \r\n**Scope:** Customer [ServiceKey][BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The page ftu id.", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/Preferences/ShowStoreFrontModal/{id}": { "put": { "tags": [ "Preferences" ], "summary": "Configures the setting that indicates whether to show the StoreFront introduction modal on the StoreFront Configuration page.\r\n**Scope:** Customer [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The id of the storefront modal (default 1)", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "get": { "tags": [ "Preferences" ], "summary": "Gets the setting that indicates whether to show the StoreFront introduction modal on the StoreFront Configuration page.\r\n**Scope:** Customer [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The id of the storefront modal (default 1)", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "Preferences" ], "summary": "Deletes the setting that indicates whether to show the StoreFront introduction modal on the StoreFront Configuration page.\r\n**Scope:** Customer [BearerToken]", "parameters": [ { "name": "id", "in": "path", "description": "The id of the storefront modal (default 1)", "required": true, "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/Releases": { "get": { "tags": [ "Releases" ], "summary": "Gets the current release information. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.GetReleaseResultModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.GetReleaseResultModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.GetReleaseResultModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "post": { "tags": [ "Releases" ], "summary": "Gets the release info of the specified list of customers. [ServiceKey][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseModel" }, "example": "{\r\n \"customers\": [\r\n \"customer1\"\r\n ]\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseModel" }, "example": "{\r\n \"customers\": [\r\n \"customer1\"\r\n ]\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseModel" }, "example": "{\r\n \"customers\": [\r\n \"customer1\"\r\n ]\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseResultModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseResultModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseResultModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/route": { "post": { "tags": [ "Routes" ], "summary": "Create a route to resourcelocation mapping for a customer. [ServiceKey]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteCreateModel" }, "example": "{\r\n \"route\": \"Citrix/Store/PNAgent/Config.xml\",\r\n \"resourceLocationId\": \"c23d033c-6836-4876-b847-4776cb7727fc\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteCreateModel" }, "example": "{\r\n \"route\": \"Citrix/Store/PNAgent/Config.xml\",\r\n \"resourceLocationId\": \"c23d033c-6836-4876-b847-4776cb7727fc\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteCreateModel" }, "example": "{\r\n \"route\": \"Citrix/Store/PNAgent/Config.xml\",\r\n \"resourceLocationId\": \"c23d033c-6836-4876-b847-4776cb7727fc\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "get": { "tags": [ "Routes" ], "summary": "Get route info for a customer. [ServiceKey]", "parameters": [ { "name": "route", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "put": { "tags": [ "Routes" ], "summary": "Update the route. [ServiceKey]", "parameters": [ { "name": "route", "in": "query", "description": "route to update.", "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteUpdateModel" }, "example": "{\r\n \"resourceLocationId\": \"c23d033c-6836-4876-b847-4776cb7727fc\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteUpdateModel" }, "example": "{\r\n \"resourceLocationId\": \"c23d033c-6836-4876-b847-4776cb7727fc\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteUpdateModel" }, "example": "{\r\n \"resourceLocationId\": \"c23d033c-6836-4876-b847-4776cb7727fc\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] }, "delete": { "tags": [ "Routes" ], "summary": "Delete a route. [ServiceKey]", "parameters": [ { "name": "route", "in": "query", "description": "route to delete", "schema": { "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/services": { "get": { "tags": [ "Services" ], "summary": "Gets a collection of services comprising the CWC platform. [ServiceKey][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Services.PlatformServicesModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Services.PlatformServicesModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Services.PlatformServicesModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/tags/restricted": { "post": { "tags": [ "Tags" ], "summary": "Create a tagged entity with defined tag. [ServiceKey][RootOnly]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } }, { "name": "Citrix-Timeout-ms", "in": "header", "description": "Maximum time caller is willing to wait for a response before timing out the request, in milliseconds", "schema": { "maximum": 300000, "minimum": 100, "type": "number", "default": 60000 } } ], "requestBody": { "description": "Tag model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TagItemModel" }, "example": "{\r\n \"objectId\": \"root\",\r\n \"objectType\": \"customer\",\r\n \"tag\": \"internal\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TagItemModel" }, "example": "{\r\n \"objectId\": \"root\",\r\n \"objectType\": \"customer\",\r\n \"tag\": \"internal\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TagItemModel" }, "example": "{\r\n \"objectId\": \"root\",\r\n \"objectType\": \"customer\",\r\n \"tag\": \"internal\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { } ] } }, "/{customer}/tags/unrestricted": { "post": { "tags": [ "Tags" ], "summary": "Create a tagged entity with defined tag. [ServiceKey][BearerToken]", "parameters": [ { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } }, { "name": "Citrix-Timeout-ms", "in": "header", "description": "Maximum time caller is willing to wait for a response before timing out the request, in milliseconds", "schema": { "maximum": 300000, "minimum": 100, "type": "number", "default": 60000 } } ], "requestBody": { "description": "Tag model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TagItemModel" }, "example": "{\r\n \"objectId\": \"root\",\r\n \"objectType\": \"customer\",\r\n \"tag\": \"internal\"\r\n}" }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TagItemModel" }, "example": "{\r\n \"objectId\": \"root\",\r\n \"objectType\": \"customer\",\r\n \"tag\": \"internal\"\r\n}" }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TagItemModel" }, "example": "{\r\n \"objectId\": \"root\",\r\n \"objectType\": \"customer\",\r\n \"tag\": \"internal\"\r\n}" } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/tags/tag/{tag}": { "get": { "tags": [ "Tags" ], "summary": "Get tagged items by tag. [ServiceKey][BearerToken]", "parameters": [ { "name": "Token", "in": "query", "schema": { "maxLength": 8192, "minLength": 0, "type": "string" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tag", "in": "path", "description": "Tag.", "required": true, "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/tags/objectId/{objectId}": { "get": { "tags": [ "Tags" ], "summary": "Get tagged items by ObjectId. [ServiceKey][BearerToken]", "parameters": [ { "name": "Token", "in": "query", "schema": { "maxLength": 8192, "minLength": 0, "type": "string" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "objectId", "in": "path", "description": "ObjectId.", "required": true, "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/tags": { "get": { "tags": [ "Tags" ], "summary": "Get all tagged items tagged by customer. [ServiceKey][BearerToken]", "parameters": [ { "name": "Token", "in": "query", "schema": { "maxLength": 8192, "minLength": 0, "type": "string" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] }, "delete": { "tags": [ "Tags" ], "summary": "Removes tag from object. [ServiceKey][BearerToken]", "parameters": [ { "name": "objectId", "in": "query", "description": "Tagged object id.", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "tag", "in": "query", "description": "Tag.", "schema": { "maxLength": 100, "minLength": 0, "type": "string", "default": "" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } }, "/{customer}/timezones": { "get": { "tags": [ "TimeZones" ], "summary": "Get all time zones for a locale. [ServiceKey][BearerToken]", "parameters": [ { "name": "locale", "in": "query", "schema": { "maxLength": 256, "minLength": 0, "type": "string", "default": "en-US" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Citrix-ConsistencyToken", "in": "header", "description": "CosmosDB consistency token.", "schema": { "type": "string" } }, { "name": "X-Cws-TransactionId", "in": "header", "description": "Used for Citrix Cloud telemetry correlation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TimeZones.TimeZonesResultsModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TimeZones.TimeZonesResultsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TimeZones.TimeZonesResultsModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { }, { } ] } } }, "components": { "schemas": { "Citrix.CloudServices.Registry.Api.EdgeProxy.EdgeProxyEndpoint": { "required": [ "endpoint", "path", "port" ], "type": "object", "properties": { "path": { "minLength": 2, "type": "string" }, "endpoint": { "minLength": 8, "type": "string" }, "port": { "maximum": 65535, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.Api.EdgeProxy.GetEdgeProxyConfigurationResults": { "type": "object", "properties": { "edgeProxyConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.Api.EdgeProxy.EdgeProxyEndpoint" }, "nullable": true }, "httpStatusCode": { "$ref": "#/components/schemas/System.Net.HttpStatusCode" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.DataAccess.Locations.ResourceLocationsQueryResult": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationWithCustomerModel" }, "nullable": true }, "count": { "type": "integer", "format": "int32" }, "continuationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.DataSchemaModel": { "type": "object", "properties": { "readWriteVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "maxLength": 64, "minLength": 1, "pattern": "[^\\/\\\\#?%|\\[\\]{}<>$^&+]+", "type": "string" }, "internalOnly": { "type": "boolean" }, "timeZone": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationUpdateModel": { "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 1, "pattern": "[^\\/\\\\#?%|\\[\\]{}<>$^&+]+", "type": "string", "nullable": true }, "internalOnly": { "type": "boolean", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationWithCustomerModel": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "maxLength": 64, "minLength": 1, "pattern": "[^\\/\\\\#?%|\\[\\]{}<>$^&+]+", "type": "string" }, "internalOnly": { "type": "boolean" }, "timeZone": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean" }, "customerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsCountResultsModel": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationsResultsModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Locations.ResourceLocationModel" }, "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.Coachmark": { "required": [ "state" ], "type": "object", "properties": { "state": { "maxLength": 256, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Preferences.DefaultDomain": { "required": [ "domainName", "forestName" ], "type": "object", "properties": { "domainName": { "maxLength": 256, "minLength": 0, "type": "string" }, "forestName": { "maxLength": 256, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomerReleaseModel": { "type": "object", "properties": { "customer": { "type": "string", "nullable": true }, "release": { "type": "string", "nullable": true }, "option": { "type": "string", "nullable": true }, "httpStatusCode": { "$ref": "#/components/schemas/System.Net.HttpStatusCode" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseModel": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomersReleaseResultModel": { "type": "object", "properties": { "customersRelease": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Releases.CustomerReleaseModel" }, "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Releases.GetReleaseResultModel": { "type": "object", "properties": { "release": { "type": "string", "nullable": true }, "option": { "type": "string", "nullable": true }, "httpStatusCode": { "type": "string", "nullable": true }, "override": { "type": "boolean" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteCreateModel": { "required": [ "resourceLocationId", "route" ], "type": "object", "properties": { "route": { "maxLength": 8192, "minLength": 0, "pattern": "^[a-zA-Z0-9\\/._-]*$", "type": "string" }, "resourceLocationId": { "maxLength": 100, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteModel": { "type": "object", "properties": { "route": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "resourceLocationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Routes.RouteUpdateModel": { "required": [ "resourceLocationId" ], "type": "object", "properties": { "resourceLocationId": { "maxLength": 100, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Services.PlatformServiceModel": { "required": [ "canariedFqdn", "isGlobal", "name", "release", "releaseAFqdn", "releaseBFqdn" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "releaseAFqdn": { "minLength": 1, "type": "string" }, "releaseBFqdn": { "minLength": 1, "type": "string" }, "canariedFqdn": { "minLength": 1, "type": "string" }, "isGlobal": { "type": "boolean" }, "release": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.Services.PlatformServicesModel": { "required": [ "services" ], "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.Services.PlatformServiceModel" } } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TagItemModel": { "required": [ "objectId", "objectType", "tag" ], "type": "object", "properties": { "objectId": { "maxLength": 64, "minLength": 1, "type": "string" }, "objectType": { "maxLength": 64, "minLength": 1, "type": "string" }, "tag": { "maxLength": 64, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem": { "type": "object", "properties": { "taggedObjectId": { "type": "string", "nullable": true }, "objectType": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItemSegment": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TagModels.TaggedItem" }, "nullable": true }, "count": { "type": "integer", "format": "int32" }, "nextToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.MasterTermsOfServiceModel": { "required": [ "htmlContentUri", "rtfContentUri", "version" ], "type": "object", "properties": { "version": { "minLength": 1, "type": "string" }, "htmlContentUri": { "minLength": 1, "type": "string" }, "rtfContentUri": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.TermsOfService.TermsOfServiceAgreementModel": { "required": [ "resellerId", "version" ], "type": "object", "properties": { "resellerId": { "maxLength": 256, "minLength": 0, "pattern": "^[a-zA-Z0-9\\._-]*$", "type": "string" }, "version": { "maxLength": 256, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.TimeZones.TimeZoneResultModel": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiCommon.Models.TimeZones.TimeZonesResultsModel": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiCommon.Models.TimeZones.TimeZoneResultModel" }, "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiModels.ChangeEventsModel": { "required": [ "changeType", "customerId", "identifier", "transactionId", "type" ], "type": "object", "properties": { "afterChange": { "type": "string", "nullable": true }, "beforeChange": { "type": "string", "nullable": true }, "changeType": { "minLength": 1, "type": "string" }, "customerId": { "minLength": 1, "type": "string" }, "geo": { "maxLength": 32, "type": "string", "nullable": true }, "identifier": { "minLength": 1, "type": "string" }, "resourceProvider": { "type": "string", "nullable": true }, "service": { "type": "string", "nullable": true }, "timeStamp": { "type": "string", "format": "date-time", "nullable": true }, "transactionId": { "minLength": 1, "type": "string" }, "type": { "minLength": 1, "type": "string" }, "userId": { "maxLength": 128, "type": "string", "nullable": true }, "userPrincipal": { "type": "string", "nullable": true }, "systemLogCorrelationId": { "type": "string", "nullable": true }, "oid": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "sid": { "type": "string", "nullable": true }, "upn": { "type": "string", "nullable": true }, "groups": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiModels.Subscriptions.ChangeEventsObjectTypeResult": { "type": "object", "properties": { "typeName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiModels.Subscriptions.ChangeEventsObjectTypesResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Citrix.CloudServices.Registry.ApiModels.Subscriptions.ChangeEventsObjectTypeResult" }, "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionCreateModel": { "required": [ "name" ], "type": "object", "properties": { "customerFilter": { "type": "string", "nullable": true }, "customerGeoFilter": { "type": "string", "nullable": true }, "objecTypeFilter": { "type": "string", "nullable": true }, "changeTypeFilter": { "type": "string", "nullable": true }, "serviceProfileFilter": { "type": "string", "nullable": true }, "serviceProfileChangeEventsSubscription": { "type": "string", "nullable": true }, "callerServiceIdentityFilter": { "type": "string", "nullable": true }, "geoFilter": { "type": "string", "nullable": true }, "resourceProviderFilter": { "type": "string", "nullable": true }, "name": { "minLength": 1, "pattern": "^[a-zA-Z0-9]{1,18}$", "type": "string" }, "recommendedGuid": { "type": "string", "nullable": true }, "cryptoRandomId": { "maxLength": 32, "minLength": 32, "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionModel": { "type": "object", "properties": { "connectionString": { "type": "string", "nullable": true }, "topicName": { "type": "string", "nullable": true }, "subscription": { "type": "string", "nullable": true }, "filter": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "disabled": { "type": "boolean" } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateModel": { "type": "object", "properties": { "customerFilter": { "type": "string", "nullable": true }, "customerGeoFilter": { "type": "string", "nullable": true }, "objecTypeFilter": { "type": "string", "nullable": true }, "changeTypeFilter": { "type": "string", "nullable": true }, "serviceProfileFilter": { "type": "string", "nullable": true }, "serviceProfileChangeEventsSubscription": { "type": "string", "nullable": true }, "callerServiceIdentityFilter": { "type": "string", "nullable": true }, "geoFilter": { "type": "string", "nullable": true }, "resourceProviderFilter": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Citrix.CloudServices.Registry.ApiModels.Subscriptions.SubscriptionUpdateStateModel": { "type": "object", "properties": { "disabled": { "type": "boolean" } }, "additionalProperties": false }, "System.Net.HttpStatusCode": { "enum": [ "Continue", "SwitchingProtocols", "Processing", "EarlyHints", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "UnavailableForLegalReasons", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "type": "string" } }, "securitySchemes": { "CCAuthService": { "type": "http", "description": "Citrix Cloud service key (e.g. CWSAuth service=xxxxx)
Note that each service key can only be used once. Generate a new key for each call.", "scheme": "bearer", "bearerFormat": "EncryptedServiceToken" }, "CCAuthBearer": { "type": "http", "description": "Citrix Cloud Auth for admin (e.g. CWSAuth bearer=xxxxx)", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "ChangeEvents" }, { "name": "Customers" }, { "name": "CustomerTermsOfService" }, { "name": "DataSchema" }, { "name": "EdgeProxy" }, { "name": "FeatureCustomer" }, { "name": "Features" }, { "name": "Locations" }, { "name": "Ping" }, { "name": "Preferences" }, { "name": "Releases" }, { "name": "Routes" }, { "name": "Services" }, { "name": "Tags" }, { "name": "TimeZones" } ] }