Create a user

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "password": "password",
  "username": "johndoe",
  "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"

	payload := strings.NewReader("{\n  \"email\": \"john@example.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"password\": \"password\",\n  \"username\": \"johndoe\",\n  \"countryCode\": \"BR\",\n  \"groups\": [\n    \"admin-group\",\n    \"midaz-viewer-group\",\n    \"midaz-contributor-group\"\n  ],\n  \"phone\": \"+5511998888777\"\n}")

	req, _ := http.NewRequest("POST", 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: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'john@example.com',
    firstName: 'John',
    lastName: 'Doe',
    password: 'password',
    username: 'johndoe',
    countryCode: 'BR',
    groups: ['admin-group', 'midaz-viewer-group', 'midaz-contributor-group'],
    phone: '+5511998888777'
  })
};

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

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

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

print(response.text)

{
  "countryCode": "BR",
  "email": "john@example.com",
  "firstName": "John",
  "groups": [
    "<string>"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastName": "Doe",
  "mfa": {
    "emailEnabled": false,
    "enabled": true,
    "methods": [
      "app",
      "email"
    ],
    "preferredType": "app",
    "totpEnabled": true
  },
  "phone": "+5511998888777",
  "username": "johndoe"
}

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

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

Create a user

Creates a user in your organization and places it in the groups you name, which is what gives it its permissions.

This is the first call in a member’s life cycle. The password you supply is the initial one; the member changes it through PATCH /v1/users/{id}/update-password, and an administrator resets it through PATCH /v1/users/{id}/reset-password.

phone and countryCode travel TOGETHER — the identity provider validates the number against the country and refuses an unresolvable pair.

Failures:

400 — a required member is missing, or email/phone is malformed.
409 IDE-0017 — the username or e-mail already belongs to another user.
503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

POST

users

Create a user

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "password": "password",
  "username": "johndoe",
  "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"

	payload := strings.NewReader("{\n  \"email\": \"john@example.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"password\": \"password\",\n  \"username\": \"johndoe\",\n  \"countryCode\": \"BR\",\n  \"groups\": [\n    \"admin-group\",\n    \"midaz-viewer-group\",\n    \"midaz-contributor-group\"\n  ],\n  \"phone\": \"+5511998888777\"\n}")

	req, _ := http.NewRequest("POST", 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: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'john@example.com',
    firstName: 'John',
    lastName: 'Doe',
    password: 'password',
    username: 'johndoe',
    countryCode: 'BR',
    groups: ['admin-group', 'midaz-viewer-group', 'midaz-contributor-group'],
    phone: '+5511998888777'
  })
};

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

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

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

print(response.text)

{
  "countryCode": "BR",
  "email": "john@example.com",
  "firstName": "John",
  "groups": [
    "<string>"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastName": "Doe",
  "mfa": {
    "emailEnabled": false,
    "enabled": true,
    "methods": [
      "app",
      "email"
    ],
    "preferredType": "app",
    "totpEnabled": true
  },
  "phone": "+5511998888777",
  "username": "johndoe"
}

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

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

Corpo

application/json

The user to create.

string

obrigatório

Exemplo:

"john@example.com"

firstName

string

obrigatório

Exemplo:

"John"

lastName

string

obrigatório

Exemplo:

"Doe"

password

string

obrigatório

Exemplo:

"password"

username

string

obrigatório

Exemplo:

"johndoe"

countryCode

string

Exemplo:

"BR"

groups

string[]

Exemplo:

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

phone

string

Exemplo:

"+5511998888777"

Resposta

Created

countryCode

string

Exemplo:

"BR"

string

Exemplo:

"john@example.com"

firstName

string

Exemplo:

"John"

groups

string[]

string

Exemplo:

"123e4567-e89b-12d3-a456-426614174000"

lastName

string

Exemplo:

"Doe"

mfa

object

Show child attributes

phone

string

Exemplo:

"+5511998888777"

username

string

Exemplo:

"johndoe"

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

Create a user

Autorizações

Corpo

Resposta