Skip to content
NimlesNimlesNimles Docs

List groups

GET
/api/tenant/{tenantId}/Groups
curl --request GET \
  --url https://api.nimles.com/identity/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Groups \
  --header 'Authorization: Bearer <token>'

Gets a list of groups, optionally filtered by IDs. Results are restricted to the groups the caller has access to based on their role assignments (tenant → resource-group hierarchy).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantId
required
string format: uuid

Your tenant id.

Query Parameters

Section titled “Query Parameters”
ids
Array<string>

Optional array of group IDs to filter by.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
name
required
string
nullable
description
string
nullable
memberIds
Array<string>
nullable

Example generated

{
  "data": [
    {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "relations": [
        {
          "fields": {
            "additionalProperty": {
              "value": "example",
              "valueType": "example"
            }
          },
          "accessibility": "example",
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "name": "example",
          "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "entityType": "example",
          "relationType": "example"
        }
      ],
      "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "createdDate": "2026-04-15T12:00:00Z",
      "version": 1,
      "lastModified": "2026-04-15T12:00:00Z",
      "name": "example",
      "description": "example",
      "memberIds": [
        "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      ]
    }
  ]
}

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}