Update Group

Update Group

Modify details of the specified group.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/groups/{groupUrn}
COPY
Path Parameters
string
groupUrn
Required

groupUrn

Request Body
UserGroup of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "providerType": "string"
}
{
    "name": "string",
    "id": "string",
    "description": "string",
    "orgEntityRef": {
        "name": "string",
        "id": "string"
    },
    "sourceEntityRef": {
        "name": "string",
        "id": "string"
    },
    "roleEntityRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "nameInSource": "string",
    "providerType": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UserGroup of type(s) application/json;version=40.0 
"UserGroup Object"
string
name
Required

name

string
id
Optional

id

string
description
Optional

description

object
orgEntityRef
Optional

Entity reference used to describe VCD entities

object
sourceEntityRef
Optional

Entity reference used to describe VCD entities

array of object
roleEntityRefs
Optional
Constraints: maxItems: 128

The role(s) of the user. If "isGroupRole" is true, then this field is a read-only representation of the roles inherited from the user's groups.

string
nameInSource
Optional

nameInSource

string
providerType
Required

The provider type of the group. Valid values are:

  • LDAP
  • SAML
  • OAUTH

Vendor Extension

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

                    [object Object],[object Object]
Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","providerType:"string"}' https://{api_host}/cloudapi/1.0.0/groups/{groupUrn}
Availability
Added in 36.0
On This Page
Group Operations
GET
Query Groups
POST
Create Group
GET
Get Group
PUT
Update Group
DELETE
Delete Group
GET
Query Group Users