Create User - Serval Documentation

POST

/

v2

/

users

Create User

curl --request POST \
  --url https://public.api.serval.com/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "pinFields": []
}
'

import requests

url = "https://public.api.serval.com/v2/users"

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "pinFields": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '<string>', firstName: '<string>', lastName: '<string>', pinFields: []})
};

fetch('https://public.api.serval.com/v2/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://public.api.serval.com/v2/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' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'pinFields' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://public.api.serval.com/v2/users"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"pinFields\": []\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))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"pinFields\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/users")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"pinFields\": []\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "name": "<string>",
    "role": "USER_ROLE_UNSPECIFIED",
    "avatarUrl": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "deactivatedAt": "2025-01-15T01:30:15.000Z",
    "timezone": "<string>",
    "authMethod": "USER_AUTH_METHOD_UNSPECIFIED",
    "locale": "<string>",
    "department": "<string>",
    "jobTitle": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

email

string

required

firstName

string

lastName

string

role

enum<string>

Available options:

USER_ROLE_UNSPECIFIED,

USER_ROLE_ORG_MEMBER,

USER_ROLE_ORG_ADMIN,

USER_ROLE_ORG_GUEST

authMethod

enum<string> | null

Specifies the authentication method for a user. If unset, the org default applies. Set to MAGIC_LINK to allow the user to bypass SSO (e.g. guest or break-glass accounts).

Available options:

USER_AUTH_METHOD_UNSPECIFIED,

USER_AUTH_METHOD_MAGIC_LINK

pinFields

enum<string>[]

Profile fields to pin at creation. A pinned field is protected from automation (user ingestion) overwrites until it is released or replaced by a later deliberate edit. Only fields set by this request can be pinned: first_name, last_name. Without pins, creation seeds stay open for ingestion to enrich.

The governed user profile fields, which carry per-field provenance and edit protection.

Available options:

USER_PROFILE_FIELD_UNSPECIFIED,

USER_PROFILE_FIELD_FIRST_NAME,

USER_PROFILE_FIELD_LAST_NAME,

USER_PROFILE_FIELD_AVATAR_URL,

USER_PROFILE_FIELD_TIMEZONE,

USER_PROFILE_FIELD_LOCALE,

USER_PROFILE_FIELD_MANAGER,

USER_PROFILE_FIELD_DEPARTMENT,

USER_PROFILE_FIELD_JOB_TITLE

Response

200 - application/json

Success

data

data · object

Show child attributes

Create User

curl --request POST \
  --url https://public.api.serval.com/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "pinFields": []
}
'

import requests

url = "https://public.api.serval.com/v2/users"

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "pinFields": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '<string>', firstName: '<string>', lastName: '<string>', pinFields: []})
};

fetch('https://public.api.serval.com/v2/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://public.api.serval.com/v2/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' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'pinFields' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://public.api.serval.com/v2/users"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"pinFields\": []\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))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"pinFields\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/users")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"pinFields\": []\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "name": "<string>",
    "role": "USER_ROLE_UNSPECIFIED",
    "avatarUrl": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "deactivatedAt": "2025-01-15T01:30:15.000Z",
    "timezone": "<string>",
    "authMethod": "USER_AUTH_METHOD_UNSPECIFIED",
    "locale": "<string>",
    "department": "<string>",
    "jobTitle": "<string>"
  }
}