Update a Group

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactEmail": "updated@example.com",
  "displayName": "Updated Group",
  "isEnabled": true
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"contactEmail\": \"updated@example.com\",\n  \"displayName\": \"Updated Group\",\n  \"isEnabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contactEmail: 'updated@example.com',
    displayName: 'Updated Group',
    isEnabled: true
  })
};

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

import requests

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

payload = {
    "contactEmail": "updated@example.com",
    "displayName": "Updated Group",
    "isEnabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "contactEmail": "admin@example.com",
  "createdAt": "2026-01-01T00:00:00Z",
  "id": "my-group",
  "isEnabled": true,
  "isTopGroup": false,
  "manager": "admin",
  "name": "My Group",
  "parentId": "parent-group",
  "type": "custom",
  "updatedAt": "2026-06-24T10:00:00Z",
  "users": [
    "user1",
    "user2"
  ]
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

Update a Group

Changes a group’s label and contact details. Anything you omit is left alone.

The group’s name — the identifier in {id} — CANNOT be changed here or anywhere else; it is what roles and memberships point at. Membership is not edited here either: use POST /v1/groups/{id}/users and its remove counterpart.

The response carries the group’s full projection, which is wider than the one GET returns.

Failures:

400 — a supplied member is malformed.
404 — no such group in your organization.
503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

PATCH

groups

{id}

Update a Group

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactEmail": "updated@example.com",
  "displayName": "Updated Group",
  "isEnabled": true
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"contactEmail\": \"updated@example.com\",\n  \"displayName\": \"Updated Group\",\n  \"isEnabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contactEmail: 'updated@example.com',
    displayName: 'Updated Group',
    isEnabled: true
  })
};

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

import requests

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

payload = {
    "contactEmail": "updated@example.com",
    "displayName": "Updated Group",
    "isEnabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "contactEmail": "admin@example.com",
  "createdAt": "2026-01-01T00:00:00Z",
  "id": "my-group",
  "isEnabled": true,
  "isTopGroup": false,
  "manager": "admin",
  "name": "My Group",
  "parentId": "parent-group",
  "type": "custom",
  "updatedAt": "2026-06-24T10:00:00Z",
  "users": [
    "user1",
    "user2"
  ]
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

string

required

Group ID.

Example:

"midaz-viewer-group"

Body

application/json

The group members to update.

contactEmail

string

Example:

"updated@example.com"

displayName

string

Example:

"Updated Group"

isEnabled

boolean

Example:

true

Response

contactEmail

string

Example:

"admin@example.com"

createdAt

string

Example:

"2026-01-01T00:00:00Z"

string

Example:

"my-group"

isEnabled

boolean

Example:

true

isTopGroup

boolean

Example:

false

manager

string

Example:

"admin"

name

string

Example:

"My Group"

parentId

string

Example:

"parent-group"

type

string

Example:

"custom"

updatedAt

string

Example:

"2026-06-24T10:00:00Z"

users

string[]

Example:

["user1", "user2"]

Overview

Authentication

Single sign-on

Authorization

User information

Login MFA

Identity overview

Groups

Applications

Partners

Users

Account MFA

Identity providers

Application providers

Permissions

Roles

Security policies

Plugin declarations

Error handling

Update a Group

Authorizations

Path Parameters

Body

Response