Get Org

Get Org

Get specified organization.

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

orgUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Org of type(s) application/json;version=40.0 
{
    "id": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "isEnabled": false,
    "managedBy": {
        "name": "string",
        "id": "string"
    },
    "canManageOrgs": false,
    "maskedEventTaskUsername": "string",
    "directlyManagedOrgCount": 0,
    "isClassicTenant": false,
    "isProviderConsumptionOrg": false,
    "creationStatus": "string"
}
string
id
Optional

A unique identifier for the organization.

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

Name of the organization.

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

Full display name of the organization.

string
description
Optional
Constraints: maxLength: 256 default:

Description of the organization.

boolean
isEnabled
Optional

Whether the organization is enabled or not.

object
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.
string
maskedEventTaskUsername
Optional
Constraints: maxLength: 256 default: system

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.

boolean
isClassicTenant
Optional

Whether the organization is a legacy VRA-style tenant. This field cannot be updated. Note this style is deprecated and this field exists for the purpose of VRA backwards compatibility.

boolean
isProviderConsumptionOrg
Optional

Indicates if this org is a provider consumption org.

string
creationStatus
Optional

The creation status of the Organization. This is a read only field. Possible values are READY, NOT_READY, ERROR, FAILED_CREATION, and CONFLICT.


Vendor Extension

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

                    [object Object],[object Object]
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/orgs/{orgUrn}
Availability
Added in 35.0
On This Page
Org Operations
GET
Query Orgs
GET
Get Org
PUT
Update Org