List Groups

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://identity.sandbox.lerian.net/v1/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://identity.sandbox.lerian.net/v1/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://identity.sandbox.lerian.net/v1/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://identity.sandbox.lerian.net/v1/groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "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"
      ]
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 2
}

{
  "code": "IDE-1005",
  "title": "No Groups Found",
  "message": "No groups were found in the search."
}

{
  "code": "IDE-0006",
  "title": "Internal Server Error",
  "message": "The server encountered an unexpected error. Please try again later."
}

GET

groups

List Groups

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://identity.sandbox.lerian.net/v1/groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://identity.sandbox.lerian.net/v1/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://identity.sandbox.lerian.net/v1/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://identity.sandbox.lerian.net/v1/groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "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"
      ]
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 2
}

{
  "code": "IDE-1005",
  "title": "No Groups Found",
  "message": "No groups were found in the search."
}

{
  "code": "IDE-0006",
  "title": "Internal Server Error",
  "message": "The server encountered an unexpected error. Please try again later."
}

Authorizations

Authorization

string

header

required

The authorization token in the 'Bearer ' format.

Query Parameters

page

integer

default:1

The page number to retrieve.

Required range: x >= 1

limit

integer

default:10

The maximum number of items to return per page. Cannot exceed 100.

Required range: 1 <= x <= 100

Response

The list of all predefined groups available in the system.

Standard paginated response wrapper.

items

object[]

The list of items returned for the current page.

Show child attributes

page

integer

The current page number.

Example:

1

limit

integer

The maximum number of items returned per page.

Example:

10

total

integer

The total number of items available across all pages.

Example:

2

⌘I

Access Manager

Systemplane

List Groups

Authorizations

Query Parameters

Response