Update Org

Update Org

Updates an organization. If the managedBy field is being updated, the operation is asynchronous and a task is returned in the location header. Otherwise, the operation is synchronous.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/orgs/{orgUrn}
COPY
Path Parameters
string
orgUrn
Required

orgUrn

string
orgUrn
Required

orgUrn

Request Body
Org of type(s) application/json
Optional 
{
    "id": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "isEnabled": false,
    "orgVdcCount": 0,
    "catalogCount": 0,
    "vappCount": 0,
    "runningVMCount": 0,
    "userCount": 0,
    "diskCount": 0,
    "managedBy": {
        "name": "string",
        "id": "string"
    },
    "canManageOrgs": false,
    "canPublish": false,
    "maskedEventTaskUsername": "string",
    "directlyManagedOrgCount": 0
}
string
id
Optional

A unique identifier for the organization.

string As ^[a-zA-Z0-9_\-\.\!\'\(\),\$]+$
name
Required

Name of the organization.

string As (?=.*\S.*)^[^\p{Zl}\p{Zp}\p{C}]*$
displayName
Required

Full display name of the organization.

string
description
Optional

Description of the organization.

boolean
isEnabled
Optional

Whether the organization is enabled or not.

integer
orgVdcCount
Optional

The number of VDCs in the org.

integer
catalogCount
Optional

The number of catalogs in the org.

integer
vappCount
Optional

The number of vApps in the org.

integer
runningVMCount
Optional

The number of running VMs in the org.

integer
userCount
Optional

The number of users in the org.

integer
diskCount
Optional

The number of disks in the org.

EntityReference
managedBy
Optional

Entity reference used to describe VCD entities

boolean
canManageOrgs
Optional

Whether or not this org can manage other tenant orgs. This can be toggled to true to automatically perform the following steps:

  • Publishes the Default Sub-Provider Entitlement Rights Bundle to the org
  • Publishes the Sub-Provider Administrator global role (if it exists) to the org
  • Creates a Default Rights Bundle in the org containing all publishable rights that are currently published to the org. Marks that Rights Bundle as publish all.
  • Clones all default roles currently published to the org into Global Roles in the org. Marks them all publish all.
Cannot be set to false as there may be any number of Rights Bundles granting sub-provider rights to this org. Instead, unpublish any rights bundles that have the Org Traverse right from this org.
boolean
canPublish
Optional

Whether the organization can publish catalogs externally.

string
maskedEventTaskUsername
Optional

Masked username as it appears in the tenant events/tasks. Requires "Organization Edit Username Mask".

integer
directlyManagedOrgCount
Optional

The count of the orgs this org directly manages.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Org of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "isEnabled": false,
    "orgVdcCount": 0,
    "catalogCount": 0,
    "vappCount": 0,
    "runningVMCount": 0,
    "userCount": 0,
    "diskCount": 0,
    "managedBy": {
        "name": "string",
        "id": "string"
    },
    "canManageOrgs": false,
    "canPublish": false,
    "maskedEventTaskUsername": "string",
    "directlyManagedOrgCount": 0
}
string
id
Optional

A unique identifier for the organization.

string As ^[a-zA-Z0-9_\-\.\!\'\(\),\$]+$
name
Required

Name of the organization.

string As (?=.*\S.*)^[^\p{Zl}\p{Zp}\p{C}]*$
displayName
Required

Full display name of the organization.

string
description
Optional

Description of the organization.

boolean
isEnabled
Optional

Whether the organization is enabled or not.

integer
orgVdcCount
Optional

The number of VDCs in the org.

integer
catalogCount
Optional

The number of catalogs in the org.

integer
vappCount
Optional

The number of vApps in the org.

integer
runningVMCount
Optional

The number of running VMs in the org.

integer
userCount
Optional

The number of users in the org.

integer
diskCount
Optional

The number of disks in the org.

EntityReference
managedBy
Optional

Entity reference used to describe VCD entities

boolean
canManageOrgs
Optional

Whether or not this org can manage other tenant orgs. This can be toggled to true to automatically perform the following steps:

  • Publishes the Default Sub-Provider Entitlement Rights Bundle to the org
  • Publishes the Sub-Provider Administrator global role (if it exists) to the org
  • Creates a Default Rights Bundle in the org containing all publishable rights that are currently published to the org. Marks that Rights Bundle as publish all.
  • Clones all default roles currently published to the org into Global Roles in the org. Marks them all publish all.
Cannot be set to false as there may be any number of Rights Bundles granting sub-provider rights to this org. Instead, unpublish any rights bundles that have the Org Traverse right from this org.
boolean
canPublish
Optional

Whether the organization can publish catalogs externally.

string
maskedEventTaskUsername
Optional

Masked username as it appears in the tenant events/tasks. Requires "Organization Edit Username Mask".

integer
directlyManagedOrgCount
Optional

The count of the orgs this org directly manages.


202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Availability
Added in 36.0
On This Page
Org Operations
POST
Create Org
DELETE
Delete Org
GET
Get Org
GET
Query Orgs
PUT
Update Org