Get Group

Get Group

Get a specified group.

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

groupUrn

string
groupUrn
Required

groupUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UserGroup of type(s) application/json;version=39.0 
{
    "name": "string",
    "id": "string",
    "description": "string",
    "orgEntityRef": {
        "name": "string",
        "id": "string"
    },
    "sourceEntityRef": {
        "name": "string",
        "id": "string"
    },
    "roleEntityRef": {
        "name": "string",
        "id": "string"
    },
    "nameInSource": "string",
    "providerType": "string"
}
string
name
Required

name

string
id
Optional

id

string
description
Required

description

EntityReference
orgEntityRef
Required

Entity reference used to describe VCD entities

EntityReference
sourceEntityRef
Optional

Entity reference used to describe VCD entities

EntityReference
roleEntityRef
Required

Entity reference used to describe VCD entities

string
nameInSource
Optional

nameInSource

string
providerType
Required

The provider type of the group. Valid values are:

  • LDAP
  • SAML
  • OAUTH

Availability
Added in 35.0
On This Page
Group Operations
POST
Create Group
DELETE
Delete Group
GET
Get Group
GET
Query Groups
GET
Query Group Users
PUT
Update Group