PUT Tenants({id})/Validate

Validate the details for updating a tenant. See Validation.

Request Information

Parameters

NameDescriptionAdditional information
id

ID of the tenant to validate the update for.

Type: String

Request body type

UpdateTenantModel

Request body formats

application/json, text/json

Sample:
{
  "Name": "tenant 1",
  "Description": "my first tenant",
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ],
  "StoreFrontIsolationMode": "PrivateServerGroup",
  "LocationUserGroups": [
    {
      "UserGroupName": "DOMAIN\\tenant1 datacenter1 users",
      "PrimaryDataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
    }
  ],
  "NetScalerGatewayIsolationMode": "Private",
  "TenantDataCenters": [
    {
      "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
      "NetScalerGatewayAddress": "https://ag.tenant1.datacenter1.mydomain.com"
    }
  ],
  "IsAacEnabled": true,
  "AacFarmName": "tenant 1",
  "UsePrivateNetwork": true,
  "PrivateManagementNetwork": "tenant 1 network"
}

Response Information

See Validation.

Response type

ValidationResultModel<UpdateTenantModel>

Response body formats

application/json, text/json

Sample:
{
  "Input": {
    "Name": "tenant 1",
    "Description": "my first tenant",
    "Tags": [
      "tag"
    ],
    "CustomProperties": [
      {
        "Name": "myProperty",
        "Value": "myValue"
      }
    ],
    "StoreFrontIsolationMode": "PrivateServerGroup",
    "LocationUserGroups": [
      {
        "UserGroupName": "DOMAIN\\tenant1 datacenter1 users",
        "PrimaryDataCenterId": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a"
      }
    ],
    "NetScalerGatewayIsolationMode": "Private",
    "TenantDataCenters": [
      {
        "Id": "af1fc9c4-dee5-4b0d-836c-9e1c5b57a88a",
        "NetScalerGatewayAddress": "https://ag.tenant1.datacenter1.mydomain.com"
      }
    ],
    "IsAacEnabled": true,
    "AacFarmName": "tenant 1",
    "UsePrivateNetwork": true,
    "PrivateManagementNetwork": "tenant 1 network"
  },
  "Errors": [
    {
      "MemberNames": [
        "Name"
      ],
      "ErrorMessage": "Name already in use",
      "ErrorCode": "Conflict"
    }
  ]
}