Update a Customer Organization

You can update the details of a customer organization by using the customer organization management API.

Prerequisites

  • You have the Provider Administrator, Provider Operations Administrator, or Provider Account Administrator role in your VMware Cloud Partner Navigator provider organization.
  • Obtain an access token from the organization you want to manage and set it as the csp-auth-token request header. See Using VMware Cloud Partner Navigator APIs.
  • Set the Content-Type header of this request to application/json.

Procedure

  1. In the body of the request, enter the parameters of a customer organization that you want to update.
    {
    "tenantType": "",
    "country": "",
    "displayName": "",
    "companyName": "",
    "city": "",
    "state": "",
    "zip": "",
    "domain": "",
    "adminUserEmail": "",
    "tag": "",
    "addressLine1": ""
    }
    The adminUserEmail and tag input parameters are optional.
  2. To update a customer organization, use your provider organization ID and run a PUT request.
    PUT https://console.navigator.vmware.com/cphub/api/core/v1/mgmt/orgs/org_ID

Results

The customer organization is updated with the new information.

Example: Update a Customer Organization

This example updates the details of a customer organization.

Enter the updated customer organization parameters in the request body.
{
"tenantType": "DEFAULT",
"country": "US",
"displayName": "Coke 2",
"companyName": "The Coca-Cola Company",
"city": "Atlanta",
"state": "GA",
"zip": "30313",
"domain": "coke.com",
"adminUserEmail": "",
"tag": "",
"addressLine1": "Rosebery Avenue 13"
}
Update the customer organization details.
PUT https://console.navigator.vmware.com/cphub/api/core/v1/mgmt/orgs/534039c2-c11d-4725-b14c-bf7476fda4a8
The response returns the updated customer organization information.
{
  "createTimestamp": 1565303037087,
  "updateTimestamp": 1571666716120,
  "id": "534039c2-c11d-4725-b14c-bf7476fda4a8",
  "name": "jz390gbi",
  "displayName": "Lorem",
  "companyName": "Lorem Ipsum",
  "country": "US",
  "state": "GA",
  "city": "Atlanta",
  "zip": "30313",
  "domain": "lorem.com",
  "tag": "",
  "addressLine1": "Rosebery Avenue 13"
  "status": "ACTIVE",
  "orgType": "TENANT",
  "parentOrgId": "d7f32037-b9b5-41ec-9394-ba3edbbc9cac",
  "childOrgIds": [],
  "tenantType": "DEFAULT",
  "isFederated": true
}