POST /users - Bengal

Request Body

requiredapplication/json

Schema: UserCreate

201 User created

Content-Type: application/json

Schema: User

400 Validation failed

Content-Type: application/json

Examples

BASH

curl -X POST "https://api.example.com/users" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com",
  "password": "string",
  "display_name": "string",
  "roles": [
    "admin"
  ],
  "addresses": [
    {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string"
    }
  ]
}'

python

PYTHON

import requests

url = "https://api.example.com/users"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "email": "user@example.com",
    "password": "string",
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "addresses": [
        {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "state": "string",
            "postal_code": "string",
            "country": "string"
        }
    ]
}

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

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users";

const options = {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "user@example.com",
    "password": "string",
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "addresses": [
        {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "state": "string",
            "postal_code": "string",
            "country": "string"
        }
    ]
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

package main

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

func main() {
	url := "https://api.example.com/users"

	body := []byte(`{"email": "user@example.com", "password": "string", "display_name": "string", "roles": ["admin"], "addresses": [{"line1": "string", "line2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string"}]}`)
	req, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users")

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

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "email": "user@example.com",\n  "password": "string",\n  "display_name": "string",\n  "roles": [\n    "admin"\n  ],\n  "addresses": [\n    {\n      "line1": "string",\n      "line2": "string",\n      "city": "string",\n      "state": "string",\n      "postal_code": "string",\n      "country": "string"\n    }\n  ]\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['email' => 'user@example.com', 'password' => 'string', 'display_name' => 'string', 'roles' => ['admin'], 'addresses' => [['line1' => 'string', 'line2' => 'string', 'city' => 'string', 'state' => 'string', 'postal_code' => 'string', 'country' => 'string']]],
];

$response = $client->request('POST', $url, $options);

echo $response->getBody();

Create user

Request Body

Responses