Create client
curl --request POST \
--url https://api.identety.dev/users \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "john@example.com",
"password": "password123",
"name": "John Doe",
"givenName": "John",
"familyName": "Doe",
"picture": "https://example.com/photo.jpg",
"locale": "en-US",
"address": {
"streetAddress": "123 Main St",
"locality": "New York",
"region": "NY",
"postalCode": "10001",
"country": "USA"
},
"metadata": {
"customField": "value"
}
}
'import requests
url = "https://api.identety.dev/users"
payload = {
"email": "john@example.com",
"password": "password123",
"name": "John Doe",
"givenName": "John",
"familyName": "Doe",
"picture": "https://example.com/photo.jpg",
"locale": "en-US",
"address": {
"streetAddress": "123 Main St",
"locality": "New York",
"region": "NY",
"postalCode": "10001",
"country": "USA"
},
"metadata": { "customField": "value" }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'john@example.com',
password: 'password123',
name: 'John Doe',
givenName: 'John',
familyName: 'Doe',
picture: 'https://example.com/photo.jpg',
locale: 'en-US',
address: {
streetAddress: '123 Main St',
locality: 'New York',
region: 'NY',
postalCode: '10001',
country: 'USA'
},
metadata: {customField: 'value'}
})
};
fetch('https://api.identety.dev/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.identety.dev/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([
'email' => 'john@example.com',
'password' => 'password123',
'name' => 'John Doe',
'givenName' => 'John',
'familyName' => 'Doe',
'picture' => 'https://example.com/photo.jpg',
'locale' => 'en-US',
'address' => [
'streetAddress' => '123 Main St',
'locality' => 'New York',
'region' => 'NY',
'postalCode' => '10001',
'country' => 'USA'
],
'metadata' => [
'customField' => 'value'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.identety.dev/users"
payload := strings.NewReader("{\n \"email\": \"john@example.com\",\n \"password\": \"password123\",\n \"name\": \"John Doe\",\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"picture\": \"https://example.com/photo.jpg\",\n \"locale\": \"en-US\",\n \"address\": {\n \"streetAddress\": \"123 Main St\",\n \"locality\": \"New York\",\n \"region\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"USA\"\n },\n \"metadata\": {\n \"customField\": \"value\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.identety.dev/users")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john@example.com\",\n \"password\": \"password123\",\n \"name\": \"John Doe\",\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"picture\": \"https://example.com/photo.jpg\",\n \"locale\": \"en-US\",\n \"address\": {\n \"streetAddress\": \"123 Main St\",\n \"locality\": \"New York\",\n \"region\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"USA\"\n },\n \"metadata\": {\n \"customField\": \"value\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.identety.dev/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"john@example.com\",\n \"password\": \"password123\",\n \"name\": \"John Doe\",\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"picture\": \"https://example.com/photo.jpg\",\n \"locale\": \"en-US\",\n \"address\": {\n \"streetAddress\": \"123 Main St\",\n \"locality\": \"New York\",\n \"region\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"USA\"\n },\n \"metadata\": {\n \"customField\": \"value\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "43fad864-738d-4367-a012-2b8c6948c36a",
"name": "John Doe",
"givenName": "John",
"familyName": "Doe",
"picture": "https://example.com/photo.jpg",
"locale": "en-US",
"address": {
"streetAddress": "123 Main St",
"locality": "New York",
"region": "NY",
"postalCode": "10001",
"country": "USA"
},
"metadata": {
"customField": "value"
}
}{
"message": "Invalid API key",
"statusCode": 401,
"error": "Unauthorized"
}{
"message": "Not Found",
"statusCode": 401
}Users
Create User
POST
/
users
Create client
curl --request POST \
--url https://api.identety.dev/users \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "john@example.com",
"password": "password123",
"name": "John Doe",
"givenName": "John",
"familyName": "Doe",
"picture": "https://example.com/photo.jpg",
"locale": "en-US",
"address": {
"streetAddress": "123 Main St",
"locality": "New York",
"region": "NY",
"postalCode": "10001",
"country": "USA"
},
"metadata": {
"customField": "value"
}
}
'import requests
url = "https://api.identety.dev/users"
payload = {
"email": "john@example.com",
"password": "password123",
"name": "John Doe",
"givenName": "John",
"familyName": "Doe",
"picture": "https://example.com/photo.jpg",
"locale": "en-US",
"address": {
"streetAddress": "123 Main St",
"locality": "New York",
"region": "NY",
"postalCode": "10001",
"country": "USA"
},
"metadata": { "customField": "value" }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'john@example.com',
password: 'password123',
name: 'John Doe',
givenName: 'John',
familyName: 'Doe',
picture: 'https://example.com/photo.jpg',
locale: 'en-US',
address: {
streetAddress: '123 Main St',
locality: 'New York',
region: 'NY',
postalCode: '10001',
country: 'USA'
},
metadata: {customField: 'value'}
})
};
fetch('https://api.identety.dev/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.identety.dev/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([
'email' => 'john@example.com',
'password' => 'password123',
'name' => 'John Doe',
'givenName' => 'John',
'familyName' => 'Doe',
'picture' => 'https://example.com/photo.jpg',
'locale' => 'en-US',
'address' => [
'streetAddress' => '123 Main St',
'locality' => 'New York',
'region' => 'NY',
'postalCode' => '10001',
'country' => 'USA'
],
'metadata' => [
'customField' => 'value'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.identety.dev/users"
payload := strings.NewReader("{\n \"email\": \"john@example.com\",\n \"password\": \"password123\",\n \"name\": \"John Doe\",\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"picture\": \"https://example.com/photo.jpg\",\n \"locale\": \"en-US\",\n \"address\": {\n \"streetAddress\": \"123 Main St\",\n \"locality\": \"New York\",\n \"region\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"USA\"\n },\n \"metadata\": {\n \"customField\": \"value\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.identety.dev/users")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john@example.com\",\n \"password\": \"password123\",\n \"name\": \"John Doe\",\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"picture\": \"https://example.com/photo.jpg\",\n \"locale\": \"en-US\",\n \"address\": {\n \"streetAddress\": \"123 Main St\",\n \"locality\": \"New York\",\n \"region\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"USA\"\n },\n \"metadata\": {\n \"customField\": \"value\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.identety.dev/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"john@example.com\",\n \"password\": \"password123\",\n \"name\": \"John Doe\",\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"picture\": \"https://example.com/photo.jpg\",\n \"locale\": \"en-US\",\n \"address\": {\n \"streetAddress\": \"123 Main St\",\n \"locality\": \"New York\",\n \"region\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"USA\"\n },\n \"metadata\": {\n \"customField\": \"value\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "43fad864-738d-4367-a012-2b8c6948c36a",
"name": "John Doe",
"givenName": "John",
"familyName": "Doe",
"picture": "https://example.com/photo.jpg",
"locale": "en-US",
"address": {
"streetAddress": "123 Main St",
"locality": "New York",
"region": "NY",
"postalCode": "10001",
"country": "USA"
},
"metadata": {
"customField": "value"
}
}{
"message": "Invalid API key",
"statusCode": 401,
"error": "Unauthorized"
}{
"message": "Not Found",
"statusCode": 401
}Authorizations
Body
application/json
Example:
"john@example.com"
Minimum string length:
8Example:
"password123"
Example:
"John Doe"
Example:
"John"
Example:
"Doe"
Example:
"https://example.com/photo.jpg"
Example:
"en-US"
Show child attributes
Show child attributes
Example:
{ "customField": "value" }
Response
Client created successfully.
Example:
"43fad864-738d-4367-a012-2b8c6948c36a"
Example:
"John Doe"
Example:
"John"
Example:
"Doe"
Example:
"https://example.com/photo.jpg"
Example:
"en-US"
Show child attributes
Show child attributes
Example:
{ "customField": "value" }
⌘I