---
updatedAt: 2026-05-12T09:59:54.000Z
---

# Retrieve group roles

This operation returns an object containing information about users associated with the specified Sentinel group.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Group API v2 (Legacy)",
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/v2/group/{client_id}/{group_id}/role": {
      "get": {
        "tags": [
          "Group API v1.0"
        ],
        "summary": "Retrieve group roles",
        "operationId": "getGroupRoles",
        "description": "This operation returns an object containing information about users associated with the specified Sentinel group.",
        "parameters": [
          {
            "name": "client_id",
            "in": "path",
            "description": "Client ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "group_id",
            "in": "path",
            "description": "Group ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:limit",
            "in": "query",
            "description": "Number of pages to retrieve.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:offset",
            "in": "query",
            "description": "Begin retrieving pages from this index.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:order_by",
            "in": "query",
            "description": "Order results in ascending or descending order by name, id, or description.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "name",
              "example": "name",
              "enum": [
                "name",
                "name_asc",
                "name_desc",
                "id",
                "id_asc",
                "id_desc",
                "description",
                "description_asc",
                "description_desc"
              ]
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Selects the requested response representation format.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Provides the information about roles of particular Sentinel groups.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupV2RoleCollection"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "GroupV2Role": {
        "properties": {
          "role": {
            "type": "string"
          },
          "id": {
            "type": "number"
          },
          "client_id": {
            "type": "number"
          },
          "username": {
            "type": "string"
          },
          "href": {
            "type": "string"
          }
        }
      },
      "GroupV2RoleCollection": {
        "properties": {
          "type": {
            "type": "string"
          },
          "collection": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupV2Role"
            }
          },
          "page": {
            "properties": {
              "total": {
                "type": "number"
              }
            },
            "type": "object"
          },
          "href": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```