Skip to main content
Browse Documentation
HTTP - Management

Get a group

Created by zengenti, last updated 17 Jun 2022

A group resource can be retrieved any valid Group Identifier.

GET/api/security/groups/{groupIdentifier}

Parameter

NameParameter typeTypeFormatDescriptionExampleRequired
groupIdentifierpathstringgroup identifierFor convenience, Group resources can be referenced by using either the group name or id"Paper Street Soap Company" or "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c"true

Examples

Get a group by id

HTTP
GET: /api/security/groups/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c

Get a group by name

HTTP
GET: /api/security/groups/Paper%20Street%20Soap%20Company

Remarks

Permissions

Member of System Administrators.

Responses

HTTP status codeReasonModel
200SuccessGroup
401UnauthorizedError
403ForbiddenError
404Group not foundError
500Internal server errorError