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

UserGroup

Group Spec object.


Properties

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
Added in 34.0

string
nameInSource Optional

sourceEntityRef Optional

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

JSON Example

{
	"description": "string",
	"name": "string",
	"orgEntityRef": {},
	"providerType": "string",
	"roleEntityRef": {}
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    id:
        x-vcloud-constraints:
            - constraint: NonSortable
            - constraint: ReadOnly
            - args:
                - arg: group
              constraint: Urn
    sourceEntityRef:
        x-vcloud-deprecated-alternative: This field is unused.
        x-vcloud-deprecated-in: "36.0"
[{"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
Property Of

InlineUserGroups1
Parameter To

Create Group
Update Group
Returned By

Create Group
Get Group
Update Group
Search LDAP Groups

Feedback

Was this page helpful?