UserGroup

UserGroup
UserGroup

Group Spec object.

JSON Example
{
    "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"
}
string
name
Required

name

string
id
Optional

id

string
description
Optional

description

EntityReference
orgEntityRef
Optional

Entity reference used to describe VCD entities

EntityReference
sourceEntityRef
Optional

Entity reference used to describe VCD entities

array of EntityReference
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
Parameter To
Returned By