GET api/v2/groups/{groupName}

Retrieves a group by name.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupName

The exact name of the group.

string

Required

Body Parameters

None.

Response Information

Resource Description

ViewGroupDTO
NameDescriptionTypeAdditional information
id

Unique Group ID

integer

None.

name

Group Name

string

None.

description

Group description

string

None.

tags

Group tags, comma seperated list of tags

string

None.

Response Formats

application/json, text/json, application/scim+json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "tags": "sample string 4"
}