[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Update Org

Description

Updates an organization.

Request

URL

put

https://{api_host}/cloudapi/1.0.0/orgs/{orgUrn}

Copy

Path Parameters

string

orgUrn Required

orgUrn

Request Body

Org of type(s) application/json Required

Show optional properties

{
	"displayName": "string",
	"name": "string"
}

{
	"canPublish": false,
	"catalogCount": 0,
	"description": "string",
	"diskCount": 0,
	"displayName": "string",
	"id": "string",
	"isEnabled": false,
	"name": "string",
	"orgVdcCount": 0,
	"runningVMCount": 0,
	"userCount": 0,
	"vappCount": 0
}

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.

boolean

canPublish Optional

Whether the organization can publish catalogs externally.

string

description Optional

Description of the organization.

integer

diskCount Optional

The number of disks in the org.

string

id Optional

A unique identifier for the organization.

boolean

isEnabled Optional

Whether the organization is enabled or not.

integer

catalogCount Optional

The number of catalogs in the org.

integer

orgVdcCount Optional

The number of VDCs 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

vappCount Optional

The number of vApps in the org.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns Org of type(s) application/json;version=37.2

{
	"canPublish": false,
	"catalogCount": 0,
	"description": "string",
	"diskCount": 0,
	"displayName": "string",
	"id": "string",
	"isEnabled": false,
	"name": "string",
	"orgVdcCount": 0,
	"runningVMCount": 0,
	"userCount": 0,
	"vappCount": 0
}

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.

boolean

canPublish Optional

Whether the organization can publish catalogs externally.

string

description Optional

Description of the organization.

integer

diskCount Optional

The number of disks in the org.

string

id Optional

A unique identifier for the organization.

boolean

isEnabled Optional

Whether the organization is enabled or not.

integer

catalogCount Optional

The number of catalogs in the org.

integer

orgVdcCount Optional

The number of VDCs 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

vappCount Optional

The number of vApps in the org.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"canPublish":false,"catalogCount":0,"description":"string","diskCount":0,"displayName":"string","id":"string","isEnabled":false,"name":"string","orgVdcCount":0,"runningVMCount":0,"userCount":0,"vappCount":0}' https://{api_host}/cloudapi/1.0.0/orgs/{orgUrn}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vcloud-event: com/vmware/vcloud/event/org/modify

vmware-cloud-director

Availability

Added in 36.0

Org Operations

post

Create Org

delete

Delete Org

get

Get Org

get

Query Orgs

put

Update Org

Update Org

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Vendor Extensions

Availability

On This Page

Org Operations

Was this page helpful?