List Groups

Use this endpoint to list all predefined groups available in the system.

GET /v1/groups

List Groups

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/groups \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "createdAt": "2025-04-08T08:01:30.169Z",
    "id": "midaz-viewer-group",
    "name": "Midaz Viewer",
    "users": [
      "johndoe",
      "janedoe"
    ]
  },
  {
    "createdAt": "2025-04-07T18:57:57.312Z",
    "id": "midaz-editor-group",
    "name": "Midaz Editor",
    "users": [
      "johnsmith"
    ]
  }
]

Authorizations

Authorization · string · header · required

The authorization token in the 'Bearer ' format.

Response

200

application/json

The list of all predefined groups available in the system.

createdAt · string

Timestamp of when the group was created.

id · string

Unique identifier of the group.

name · string

Display name of the group.

users · string[]

List of users assigned to the group.