Create user
curl --request POST \
--url https://api.hexclave.com/api/v1/users \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "John Doe",
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
},
"server_metadata": {
"key": "value"
},
"primary_email": "johndoe@example.com",
"primary_email_verified": true,
"primary_email_auth_enabled": true,
"password": "my-new-password",
"totp_secret_base64": "dG90cC1zZWNyZXQ=",
"restricted_by_admin": false,
"restricted_by_admin_reason": null,
"restricted_by_admin_private_details": null,
"country_code": "US"
}
'import requests
url = "https://api.hexclave.com/api/v1/users"
payload = {
"display_name": "John Doe",
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": { "key": "value" },
"client_read_only_metadata": { "key": "value" },
"server_metadata": { "key": "value" },
"primary_email": "johndoe@example.com",
"primary_email_verified": True,
"primary_email_auth_enabled": True,
"password": "my-new-password",
"totp_secret_base64": "dG90cC1zZWNyZXQ=",
"restricted_by_admin": False,
"restricted_by_admin_reason": None,
"restricted_by_admin_private_details": None,
"country_code": "US"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'John Doe',
profile_image_url: 'https://example.com/image.jpg',
client_metadata: {key: 'value'},
client_read_only_metadata: {key: 'value'},
server_metadata: {key: 'value'},
primary_email: 'johndoe@example.com',
primary_email_verified: true,
primary_email_auth_enabled: true,
password: 'my-new-password',
totp_secret_base64: 'dG90cC1zZWNyZXQ=',
restricted_by_admin: false,
restricted_by_admin_reason: null,
restricted_by_admin_private_details: null,
country_code: 'US'
})
};
fetch('https://api.hexclave.com/api/v1/users', 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://api.hexclave.com/api/v1/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'display_name' => 'John Doe',
'profile_image_url' => 'https://example.com/image.jpg',
'client_metadata' => [
'key' => 'value'
],
'client_read_only_metadata' => [
'key' => 'value'
],
'server_metadata' => [
'key' => 'value'
],
'primary_email' => 'johndoe@example.com',
'primary_email_verified' => true,
'primary_email_auth_enabled' => true,
'password' => 'my-new-password',
'totp_secret_base64' => 'dG90cC1zZWNyZXQ=',
'restricted_by_admin' => false,
'restricted_by_admin_reason' => null,
'restricted_by_admin_private_details' => null,
'country_code' => 'US'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hexclave.com/api/v1/users"
payload := strings.NewReader("{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\",\n \"client_metadata\": {\n \"key\": \"value\"\n },\n \"client_read_only_metadata\": {\n \"key\": \"value\"\n },\n \"server_metadata\": {\n \"key\": \"value\"\n },\n \"primary_email\": \"johndoe@example.com\",\n \"primary_email_verified\": true,\n \"primary_email_auth_enabled\": true,\n \"password\": \"my-new-password\",\n \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n \"restricted_by_admin\": false,\n \"restricted_by_admin_reason\": null,\n \"restricted_by_admin_private_details\": null,\n \"country_code\": \"US\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.hexclave.com/api/v1/users")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\",\n \"client_metadata\": {\n \"key\": \"value\"\n },\n \"client_read_only_metadata\": {\n \"key\": \"value\"\n },\n \"server_metadata\": {\n \"key\": \"value\"\n },\n \"primary_email\": \"johndoe@example.com\",\n \"primary_email_verified\": true,\n \"primary_email_auth_enabled\": true,\n \"password\": \"my-new-password\",\n \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n \"restricted_by_admin\": false,\n \"restricted_by_admin_reason\": null,\n \"restricted_by_admin_private_details\": null,\n \"country_code\": \"US\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hexclave.com/api/v1/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\",\n \"client_metadata\": {\n \"key\": \"value\"\n },\n \"client_read_only_metadata\": {\n \"key\": \"value\"\n },\n \"server_metadata\": {\n \"key\": \"value\"\n },\n \"primary_email\": \"johndoe@example.com\",\n \"primary_email_verified\": true,\n \"primary_email_auth_enabled\": true,\n \"password\": \"my-new-password\",\n \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n \"restricted_by_admin\": false,\n \"restricted_by_admin_reason\": null,\n \"restricted_by_admin_private_details\": null,\n \"country_code\": \"US\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3241a285-8329-4d69-8f3d-316e08cf140c",
"primary_email_verified": true,
"primary_email_auth_enabled": true,
"signed_up_at_millis": 1630000000000,
"last_active_at_millis": 1630000000000,
"is_anonymous": true,
"is_restricted": false,
"restricted_by_admin": false,
"risk_scores": {
"sign_up": {
"bot": 0,
"free_trial_abuse": 0
}
},
"primary_email": "johndoe@example.com",
"display_name": "John Doe",
"selected_team": {
"created_at_millis": 1630000000000,
"id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
"display_name": "My Team",
"server_metadata": {
"key": "value"
},
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
}
},
"selected_team_id": "team-id",
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
},
"server_metadata": {
"key": "value"
},
"restricted_reason": null,
"restricted_by_admin_reason": null,
"restricted_by_admin_private_details": null,
"country_code": "US"
}Users
Create user
Creates a new user. E-mail authentication is always enabled, and no password is set, meaning the only way to authenticate the newly created user is through magic link.
POST
/
users
Create user
curl --request POST \
--url https://api.hexclave.com/api/v1/users \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "John Doe",
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
},
"server_metadata": {
"key": "value"
},
"primary_email": "johndoe@example.com",
"primary_email_verified": true,
"primary_email_auth_enabled": true,
"password": "my-new-password",
"totp_secret_base64": "dG90cC1zZWNyZXQ=",
"restricted_by_admin": false,
"restricted_by_admin_reason": null,
"restricted_by_admin_private_details": null,
"country_code": "US"
}
'import requests
url = "https://api.hexclave.com/api/v1/users"
payload = {
"display_name": "John Doe",
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": { "key": "value" },
"client_read_only_metadata": { "key": "value" },
"server_metadata": { "key": "value" },
"primary_email": "johndoe@example.com",
"primary_email_verified": True,
"primary_email_auth_enabled": True,
"password": "my-new-password",
"totp_secret_base64": "dG90cC1zZWNyZXQ=",
"restricted_by_admin": False,
"restricted_by_admin_reason": None,
"restricted_by_admin_private_details": None,
"country_code": "US"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'John Doe',
profile_image_url: 'https://example.com/image.jpg',
client_metadata: {key: 'value'},
client_read_only_metadata: {key: 'value'},
server_metadata: {key: 'value'},
primary_email: 'johndoe@example.com',
primary_email_verified: true,
primary_email_auth_enabled: true,
password: 'my-new-password',
totp_secret_base64: 'dG90cC1zZWNyZXQ=',
restricted_by_admin: false,
restricted_by_admin_reason: null,
restricted_by_admin_private_details: null,
country_code: 'US'
})
};
fetch('https://api.hexclave.com/api/v1/users', 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://api.hexclave.com/api/v1/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'display_name' => 'John Doe',
'profile_image_url' => 'https://example.com/image.jpg',
'client_metadata' => [
'key' => 'value'
],
'client_read_only_metadata' => [
'key' => 'value'
],
'server_metadata' => [
'key' => 'value'
],
'primary_email' => 'johndoe@example.com',
'primary_email_verified' => true,
'primary_email_auth_enabled' => true,
'password' => 'my-new-password',
'totp_secret_base64' => 'dG90cC1zZWNyZXQ=',
'restricted_by_admin' => false,
'restricted_by_admin_reason' => null,
'restricted_by_admin_private_details' => null,
'country_code' => 'US'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hexclave.com/api/v1/users"
payload := strings.NewReader("{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\",\n \"client_metadata\": {\n \"key\": \"value\"\n },\n \"client_read_only_metadata\": {\n \"key\": \"value\"\n },\n \"server_metadata\": {\n \"key\": \"value\"\n },\n \"primary_email\": \"johndoe@example.com\",\n \"primary_email_verified\": true,\n \"primary_email_auth_enabled\": true,\n \"password\": \"my-new-password\",\n \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n \"restricted_by_admin\": false,\n \"restricted_by_admin_reason\": null,\n \"restricted_by_admin_private_details\": null,\n \"country_code\": \"US\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.hexclave.com/api/v1/users")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\",\n \"client_metadata\": {\n \"key\": \"value\"\n },\n \"client_read_only_metadata\": {\n \"key\": \"value\"\n },\n \"server_metadata\": {\n \"key\": \"value\"\n },\n \"primary_email\": \"johndoe@example.com\",\n \"primary_email_verified\": true,\n \"primary_email_auth_enabled\": true,\n \"password\": \"my-new-password\",\n \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n \"restricted_by_admin\": false,\n \"restricted_by_admin_reason\": null,\n \"restricted_by_admin_private_details\": null,\n \"country_code\": \"US\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hexclave.com/api/v1/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"John Doe\",\n \"profile_image_url\": \"https://example.com/image.jpg\",\n \"client_metadata\": {\n \"key\": \"value\"\n },\n \"client_read_only_metadata\": {\n \"key\": \"value\"\n },\n \"server_metadata\": {\n \"key\": \"value\"\n },\n \"primary_email\": \"johndoe@example.com\",\n \"primary_email_verified\": true,\n \"primary_email_auth_enabled\": true,\n \"password\": \"my-new-password\",\n \"totp_secret_base64\": \"dG90cC1zZWNyZXQ=\",\n \"restricted_by_admin\": false,\n \"restricted_by_admin_reason\": null,\n \"restricted_by_admin_private_details\": null,\n \"country_code\": \"US\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3241a285-8329-4d69-8f3d-316e08cf140c",
"primary_email_verified": true,
"primary_email_auth_enabled": true,
"signed_up_at_millis": 1630000000000,
"last_active_at_millis": 1630000000000,
"is_anonymous": true,
"is_restricted": false,
"restricted_by_admin": false,
"risk_scores": {
"sign_up": {
"bot": 0,
"free_trial_abuse": 0
}
},
"primary_email": "johndoe@example.com",
"display_name": "John Doe",
"selected_team": {
"created_at_millis": 1630000000000,
"id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
"display_name": "My Team",
"server_metadata": {
"key": "value"
},
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
}
},
"selected_team_id": "team-id",
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
},
"server_metadata": {
"key": "value"
},
"restricted_reason": null,
"restricted_by_admin_reason": null,
"restricted_by_admin_private_details": null,
"country_code": "US"
}Body
application/json
Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.
Example:
{ "key": "value" }
Response
201 - application/json
Successful response
Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.
Example:
{ "key": "value" }