Update Org | VMware Cloud Director OpenAPI

Update Org

Updates an organization.

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
}

string

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

managedBy

boolean

canManageOrgs

Optional

Whether or not this org can manage other tenant orgs.

boolean

canPublish

Optional

Whether the organization can publish catalogs externally.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

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

{
    "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
}

string

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