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

Update Group

Description

Modify details of the specified group.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
groupUrn Required

groupUrn


Request Body

Request Body

UserGroup of type(s) application/json Required
{
	"description": "string",
	"name": "string",
	"orgEntityRef": {},
	"providerType": "string",
	"roleEntityRef": {}
}
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.

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=36.3
{
	"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 -X PUT -H "Content-Type: application/json" -d '{"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"}}' https://{api_host}/cloudapi/1.0.0/groups/{groupUrn}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vcloud-event: com/vmware/vcloud/event/group/modify


[{"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
Feedback

Was this page helpful?