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

Get Group

Description

Get a specified group.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/groups/{groupUrn}
Copy

Path Parameters

Path Parameters

string
groupUrn Required

groupUrn


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UserGroup of type(s) application/json;version=37.0
{
	"description": "string",
	"id": "string",
	"name": "string",
	"nameInSource": "string",
	"orgEntityRef": {
		"id": "string",
		"name": "string"
	},
	"providerType": "string",
	"roleEntityRef": {
		"id": "string",
		"name": "string"
	},
	"sourceEntityRef": {
		"id": "string",
		"name": "string"
	}
}
string
description Required

string
name Required

orgEntityRef Required

Entity reference used to describe VCD entities


string
providerType Required

The provider type of the group. Valid values are:

  • LDAP
  • SAML
  • OAUTH


roleEntityRef Required

Entity reference used to describe VCD entities


string
id Optional

string
nameInSource Optional

sourceEntityRef Optional

This field is under accelerated deprecation and will be removed next release.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/groups/{groupUrn}


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

Was this page helpful?