Skip to main content
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": "[email protected]",
  "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"
  }
}
'
{
  "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"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
email
string
required
​
password
string
required
Minimum string length: 8
Example:

"password123"

​
name
string
required
Example:

"John Doe"

​
givenName
string
required
Example:

"John"

​
familyName
string
required
Example:

"Doe"

​
picture
string
required
Example:

"https://example.com/photo.jpg"

​
locale
string
required
Example:

"en-US"

​
address
object
required
​
metadata
object
required
Example:
{ "customField": "value" }

Response

Client created successfully.

​
id
string
required
Example:

"43fad864-738d-4367-a012-2b8c6948c36a"

​
name
string
required
Example:

"John Doe"

​
givenName
string
required
Example:

"John"

​
familyName
string
required
Example:

"Doe"

​
picture
string
required
Example:

"https://example.com/photo.jpg"

​
locale
string
required
Example:

"en-US"

​
address
object
required
​
metadata
object
required
Example:
{ "customField": "value" }