[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"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
Update Group
DescriptionModify details of the specified group.
Request
URLURL
https://{api_host}/cloudapi/1.0.0/groups/{groupUrn}
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
string
providerType
Required
The provider type of the group. Valid values are:
- LDAP
- SAML
- OAUTH
string
id
Optional
string
nameInSource
Optional
sourceEntityRef
Optional
This field is under accelerated deprecation and will be removed next release.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
UserGroup
of type(s) application/json;version=37.2
{
"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
string
providerType
Required
The provider type of the group. Valid values are:
- LDAP
- SAML
- OAUTH
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 SamplesCode 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
This operation contains the following vendor extensions defined in the spec:
x-vcloud-event: com/vmware/vcloud/event/group/modify
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"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
Availability
Added in 36.0
On This Page
Group Operations
post
delete
get
get
put
