ConnectCloud Developers

Names of the tenant's groups (tenant:access)

GET /api/hr/v1/groups

Module: HR · operationId: listGroups · Tag: Access · Auth: access token (Authorization: Bearer <accessToken>)

Id and name of every group of the active tenant, sorted by name. Sessions carry only the group ids (groupMemberships); this resolves them to names. No members, no roles.

Responses

  • 200 Groups (application/json)
  • 401 Error (application/json)
  • 403 Error (application/json)

Fields of the 200 answer:

  • items (array of GroupName, required): The tenant's groups
    • id (string (uuid), required): Id of the group
    • name (string, required): Name of the group

Example 200 answer:

{
  "items": [
    {
      "id": "23c5e7a9-1b3d-4f5a-9c7e-9b1d3f5a7c92",
      "name": "Bereitschaft"
    },
    {
      "id": "25e7a9c1-3d5f-4a7c-8e9b-1d3f5a7c9e93",
      "name": "ER Freigabe"
    },
    {
      "id": "21a3c5e7-9b1d-4d3f-8a5c-7e9b1d3f5a91",
      "name": "Service Desk 1st Level"
    },
    {
      "id": "27a9c1e3-5f7a-4c9e-9b1d-3f5a7c9e1b94",
      "name": "Service Desk 2nd Level"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/hr/v1/groups' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI