Update a user

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "countryCode": "BR",
  "groups": [
    "admin-group",
    "midaz-viewer-group",
    "midaz-contributor-group"
  ],
  "phone": "+5511998888777"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"email\": \"john@example.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"countryCode\": \"BR\",\n  \"groups\": [\n    \"admin-group\",\n    \"midaz-viewer-group\",\n    \"midaz-contributor-group\"\n  ],\n  \"phone\": \"+5511998888777\"\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({
    email: 'john@example.com',
    firstName: 'John',
    lastName: 'Doe',
    countryCode: 'BR',
    groups: ['admin-group', 'midaz-viewer-group', 'midaz-contributor-group'],
    phone: '+5511998888777'
  })
};

fetch('https://identity.sandbox.lerian.net/v1/users/{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/users/{id}"

payload = {
    "email": "john@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "countryCode": "BR",
    "groups": ["admin-group", "midaz-viewer-group", "midaz-contributor-group"],
    "phone": "+5511998888777"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "countryCode": "BR",
  "groups": [
    "admin-group",
    "midaz-viewer-group",
    "midaz-contributor-group"
  ],
  "phone": "+5511998888777"
}

{
  "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 user

Changes a user’s identity and contact details, and its group membership.

This is the ADMINISTRATIVE merge and it can touch e-mail, name and group membership at once. A member changing their own phone number uses PATCH /v1/users/{id}/phone instead, which writes only those two fields — routing a self-service form through this merge would put group membership inside its blast radius.

An empty phone here is IGNORED, not cleared; clearing is DELETE /v1/users/{id}/phone.

The response echoes the members you submitted, not a re-read of the record.

Failures:

400 — {id} is not a UUID, or a supplied member is malformed.
404 — no such user 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

users

{id}

Update a user

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "countryCode": "BR",
  "groups": [
    "admin-group",
    "midaz-viewer-group",
    "midaz-contributor-group"
  ],
  "phone": "+5511998888777"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"email\": \"john@example.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"countryCode\": \"BR\",\n  \"groups\": [\n    \"admin-group\",\n    \"midaz-viewer-group\",\n    \"midaz-contributor-group\"\n  ],\n  \"phone\": \"+5511998888777\"\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({
    email: 'john@example.com',
    firstName: 'John',
    lastName: 'Doe',
    countryCode: 'BR',
    groups: ['admin-group', 'midaz-viewer-group', 'midaz-contributor-group'],
    phone: '+5511998888777'
  })
};

fetch('https://identity.sandbox.lerian.net/v1/users/{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/users/{id}"

payload = {
    "email": "john@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "countryCode": "BR",
    "groups": ["admin-group", "midaz-viewer-group", "midaz-contributor-group"],
    "phone": "+5511998888777"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "countryCode": "BR",
  "groups": [
    "admin-group",
    "midaz-viewer-group",
    "midaz-contributor-group"
  ],
  "phone": "+5511998888777"
}

{
  "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>"
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

string

obrigatório

User ID.

Exemplo:

"00000000-0000-0000-0000-000000000000"

Corpo

application/json

The user members to update.

string

obrigatório

Exemplo:

"john@example.com"

firstName

string

obrigatório

Exemplo:

"John"

lastName

string

obrigatório

Exemplo:

"Doe"

countryCode

string

Exemplo:

"BR"

groups

string[]

Exemplo:

[
  "admin-group",
  "midaz-viewer-group",
  "midaz-contributor-group"
]

phone

string

Exemplo:

"+5511998888777"

Resposta

string

obrigatório

Exemplo:

"john@example.com"

firstName

string

obrigatório

Exemplo:

"John"

lastName

string

obrigatório

Exemplo:

"Doe"

countryCode

string

Exemplo:

"BR"

groups

string[]

Exemplo:

[
  "admin-group",
  "midaz-viewer-group",
  "midaz-contributor-group"
]

phone

string

Exemplo:

"+5511998888777"

Visão geral

Autenticação

Login único

Autorização

Informações do usuário

MFA de login

Passkey de login

Visão geral de identidade

Grupos

Aplicações

Parceiros

Usuários

MFA da conta

Passkey da conta

Provedores de identidade

Provedores de aplicações

Permissões

Funções

Políticas de segurança

Declarações de plugins

Tratamento de erros

Update a user

Autorizações

Parâmetros de caminho

Corpo

Resposta