[{"label":"Latest (v36.3)","version":"latest"},{"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

Get Org

Description

Get specified organization.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgUrn Required

orgUrn


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns Org of type(s) application/json;version=36.3
{
	"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 Introduced Changed 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

Code Samples

cURL Command

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


[{"label":"Latest (v36.3)","version":"latest"},{"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
Availability
Added in 35.0
Org Operations
Feedback

Was this page helpful?