Get the Group List

Gets a list of groups defined for HMP that have a role.

Authorizations: All

Requests

CODE

GET /apis/groups/enabled

Response

Success

Array of group resources. Example:

JSON

{
"data": [
  {
    "baseDn": "dc=simple,dc=haivision,dc=local",
    "dn": "CN=Account Operators,CN=Builtin,DC=simple,DC= haivision,DC=local",
    "groupname": "Account Operators",
    "id": "99db0933-0941-4083-856c-320fadca834e",
    "roles": [
      "<roleID>"
    ],
    "shares": {
      "assets": {
        "05b74e69-4b27-4540-bb0a-c7042e24ce3e": {
          "mode": "OWN"
        },
        "523bbda2-e7bc-4e97-b622-e461938c9a03": {
          "mode": "WATCH"
        }
      },
      "sessions": {
        "0fb77a60-f7af-4c54-bf27-38e0a36924a1": {
          "mode": "WATCH"
        }
      }
    }
  },
  {
    "baseDn": "dc=simple,dc=haivision,dc=local",
    "dn": "CN=Administrators,CN=Builtin,DC=simple,DC=haivision,
DC=local",
  "groupname": "Administrators",
    "id": "b5b45f60-0962-4bed-8ec1-a26f76c0a1ea",
    "roles": [
      "<roleID>"
    ]
  }
],
"paging": {
  "results": 2,
  "pageSize": 15
}
}

Caution

Only id and groupname are supported. Other attributes are subject to change and should not be used in a production application.

Error

Code	Payload	Description
`404`	`{"code":"040012", "name":"NoResults",` `"message":"No results", "httpStatusCode":404}`	No groups available.
`500`	`{"code":"070000", "name":"InternalServer",` `"message":"Internal Server Error", "httpStatusCode":500}`	Error retrieving groups.