Update Tenant Properties Override

Details

API Details
Name

Update Tenant Properties Override

Description

Updates the previously set override for the tenant (vendor) properties used by the CloudCenter platform.

  • The ROOT Admin can update these property values for a specific tenant.
  • The Tenant Admin can update these property values for just their tenant.
MethodPUT
URIv1/tenantProperties/override/propertyOverrideId
CloudCenter Release
  • Introduced in CloudCenter 4.8.2
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.tenantProperties.override.propertyOverrideId

Example 1 – ROOT Admin

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenantProperties/override/48"

Request Body

{
   "propertyValue":"0"
}

Response

{
   "id":"48",
   "resource":"https://<HOST>:<PORT>/tenantProperties/override/48",
   "propertyId":32,
   "vendorId":2,
   "propertyValue":"0"
}

Example 2 – Tenant Admin

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenantProperties/override/49"

Request Body

{
   "propertyValue":"0"
}

Response

{
   "id":"49",
   "resource":"https://<ccm-ip>/tenantProperties/override/49",
   "propertyId":32,
   "vendorId":3,
   "propertyValue":"0"
}

Request Attributes

propertyOverrideId
  • DescriptionUnique, system-generated identifier for a tenant (vendor) property if its default value has been changed (overridden) by either the ROOT admin or the tenant admin.

  • Type: String

Required

propertyValue
  • Description: The default value for each tenant (vendor) property as specified in the request payload.

  • Type: String

Required

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String

propertyId
  • DescriptionUnique, system-generated identifier for a tenant (vendor) property if its default value is preset by the CloudCenter platform.

  • Type: String

vendorID
  • Description: Unique, system-generated ID for  the tenant organization

  • Type: String

propertyValue
  • Description: The default value for each tenant (vendor) property as specified in the request payload.

  • Type: String

© 2017-2019 Cisco Systems, Inc. All rights reserved