POST GlobalSettings/Validate

Validation of the initial, first-time-use global settings. See Validation.

Request Information

Request body type

Request body formats

application/json, text/json

Sample:

{
  "SharedResourceDomain": {
    "Name": "domain1.local",
    "Type": "Both",
    "IsPasswordProtected": true,
    "DomainPasswordBase64": "cGFzc3dvcmQ=",
    "OrchestrationServiceUserName": "DOMAIN\\orch",
    "OrchestrationServicePasswordBase64": "cGFzc3dvcmQ=",
    "ProductInstallUserName": "DOMAIN\\install",
    "ProductInstallPasswordBase64": "cGFzc3dvcmQ=",
    "Tags": [
      "tag"
    ],
    "CustomProperties": [
      {
        "Name": "myProperty",
        "Value": "myValue"
      }
    ]
  },
  "RootOU": "CitrixAppOrchestration",
  "DefaultPrimaryDataCenter": {
    "Name": "datacenter1",
    "ShortName": "datacenter1",
    "Description": "my datacenter",
    "Tags": [
      "tag"
    ],
    "CustomProperties": [
      {
        "Name": "myProperty",
        "Value": "myValue"
      }
    ],
    "LicenseServerAddress": "ctxlicense.csp.com",
    "LicenseServerAddressPort": 27000,
    "NetScalerGatewayAddress": "https://ag.datacenter1.csp.com"
  },
  "IsNetworkIsolationEnabled": true,
  "SharedControllerManagementNetwork": "Shared Controller Management Network",
  "SharedDeliveryGroupManagementNetwork": "Shared Delivery Group Management Network",
  "IsNetScalerGatewayEnabled": true,
  "ExternalDnsSuffix": "csp.com",
  "ProductDepot": "\\\\server\\share\\ProductDepot",
  "ProductDepotUserName": "DOMAIN\\user",
  "ProductDepotPasswordBase64": "cGFzc3dvcmQ=",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}

Response Information

See Validation.

Response type

ValidationResultModel<FirstTimeSetupGlobalSettingsModel>

Response body formats

application/json, text/json

Sample:

{
  "Input": {
    "SharedResourceDomain": {
      "Name": "domain1.local",
      "Type": "Both",
      "IsPasswordProtected": true,
      "DomainPasswordBase64": "cGFzc3dvcmQ=",
      "OrchestrationServiceUserName": "DOMAIN\\orch",
      "OrchestrationServicePasswordBase64": "cGFzc3dvcmQ=",
      "ProductInstallUserName": "DOMAIN\\install",
      "ProductInstallPasswordBase64": "cGFzc3dvcmQ=",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ]
    },
    "RootOU": "CitrixAppOrchestration",
    "DefaultPrimaryDataCenter": {
      "Name": "datacenter1",
      "ShortName": "datacenter1",
      "Description": "my datacenter",
      "Tags": [
        "tag"
      ],
      "CustomProperties": [
        {
          "Name": "myProperty",
          "Value": "myValue"
        }
      ],
      "LicenseServerAddress": "ctxlicense.csp.com",
      "LicenseServerAddressPort": 27000,
      "NetScalerGatewayAddress": "https://ag.datacenter1.csp.com"
    },
    "IsNetworkIsolationEnabled": true,
    "SharedControllerManagementNetwork": "Shared Controller Management Network",
    "SharedDeliveryGroupManagementNetwork": "Shared Delivery Group Management Network",
    "IsNetScalerGatewayEnabled": true,
    "ExternalDnsSuffix": "csp.com",
    "ProductDepot": "\\\\server\\share\\ProductDepot",
    "ProductDepotUserName": "DOMAIN\\user",
    "ProductDepotPasswordBase64": "cGFzc3dvcmQ=",
    "Tags": [
      "tag"
    ],
    "CustomProperties": [
      {
        "Name": "myProperty",
        "Value": "myValue"
      }
    ]
  },
  "Errors": [
    {
      "MemberNames": [
        "DefaultPrimaryDataCenter"
      ],
      "ErrorMessage": "Required",
      "ErrorCode": "Required"
    }
  ]
}