Create a user
Create a user. extRelationId and relStr link the user to your external system and must be unique. The generated password is returned in this response only.
Try it
Sent from this browser to your panel with your token. Changes live data.
⌘↵Request
Authorization
Authorization header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Paramsapplication/json#
Account details, external relation and self-service settings.
Full name of the user.
Email address of the user.
Relation ID.
Relational string.
Self-service level for the user; disabled by default.
| Value | Meaning |
|---|---|
0 | Disabled |
1 | Hourly |
2 | Resource packs |
3 | Hourly and resource packs |
Enable/disable credit balance billing for hourly self service. (true|false).
(default none) array of self service hourly group profile ids.
(default none) array of self service resource group profile ids.
(default none) ID of an hourly self service resource pack.
(default false) Email the access credentials to the user. (true|false).
{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}Request Code Samples
curl --location --request POST 'https://cp.domain.com/api/v1/users' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}'wget --quiet --output-document=- \
--method=POST \
--header='Authorization: Bearer <token>' \
--header='Accept: application/json' \
--header='Content-Type: application/json' \
--body-data='{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}' \
'https://cp.domain.com/api/v1/users'http POST 'https://cp.domain.com/api/v1/users' \
'Authorization: Bearer <token>' \
'Accept: application/json' \
'Content-Type: application/json' <<< '{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}'const response = await fetch("https://cp.domain.com/api/v1/users", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Accept": "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}),
});
const data = await response.json();
console.log(response.status, data);import axios from "axios";
const response = await axios({
method: "post",
url: "https://cp.domain.com/api/v1/users",
headers: {
"Authorization": "Bearer <token>",
"Accept": "application/json",
"Content-Type": "application/json",
},
data: {
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
},
});
console.log(response.status, response.data);const https = require("https");
const payload = JSON.stringify({
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
});
const req = https.request({
hostname: "cp.domain.com",
path: "/api/v1/users",
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Accept": "application/json",
"Content-Type": "application/json",
"Content-Length": Buffer.byteLength(payload),
},
}, (res) => {
let data = "";
res.on("data", (chunk) => (data += chunk));
res.on("end", () => console.log(res.statusCode, JSON.parse(data)));
});
req.on("error", (err) => console.error(err));
req.write(payload);
req.end();import requests
url = "https://cp.domain.com/api/v1/users"
headers = {
"Authorization": "Bearer <token>",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": True,
"selfServiceHourlyGroupProfiles": [
1,
2,
3,
],
"selfServiceResourceGroupProfiles": [
4,
5,
6,
],
"selfServiceHourlyResourcePack": 1,
"sendMail": False,
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.status_code)
print(response.json())import http.client
import json
conn = http.client.HTTPSConnection("cp.domain.com")
headers = {
"Authorization": "Bearer <token>",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = json.dumps({
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": True,
"selfServiceHourlyGroupProfiles": [
1,
2,
3,
],
"selfServiceResourceGroupProfiles": [
4,
5,
6,
],
"selfServiceHourlyResourcePack": 1,
"sendMail": False,
})
conn.request("POST", "/api/v1/users", payload, headers)
response = conn.getresponse()
print(response.status)
print(json.loads(response.read()))<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://cp.domain.com/api/v1/users',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Jon Doe',
'email' => 'jon@doe.com',
'extRelationId' => 1,
'selfService' => 3,
'selfServiceHourlyCredit' => true,
'selfServiceHourlyGroupProfiles' => [
1,
2,
3,
],
'selfServiceResourceGroupProfiles' => [
4,
5,
6,
],
'selfServiceHourlyResourcePack' => 1,
'sendMail' => false,
]),
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer <token>',
'Accept: application/json',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;<?php
require 'vendor/autoload.php';
use GuzzleHttp\Client;
$client = new Client();
$response = $client->request('POST', 'https://cp.domain.com/api/v1/users', [
'headers' => [
'Authorization' => 'Bearer <token>',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Jon Doe',
'email' => 'jon@doe.com',
'extRelationId' => 1,
'selfService' => 3,
'selfServiceHourlyCredit' => true,
'selfServiceHourlyGroupProfiles' => [
1,
2,
3,
],
'selfServiceResourceGroupProfiles' => [
4,
5,
6,
],
'selfServiceHourlyResourcePack' => 1,
'sendMail' => false,
],
]);
echo $response->getStatusCode() . "\n";
echo $response->getBody();package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
url := "https://cp.domain.com/api/v1/users"
payload := strings.NewReader(`{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}`)
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Accept", "application/json")
req.Header.Add("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://cp.domain.com/api/v1/users"))
.header("Authorization", "Bearer <token>")
.header("Accept", "application/json")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"name\":\"Jon Doe\",\"email\":\"jon@doe.com\",\"extRelationId\":1,\"selfService\":3,\"selfServiceHourlyCredit\":true,\"selfServiceHourlyGroupProfiles\":[1,2,3],\"selfServiceResourceGroupProfiles\":[4,5,6],\"selfServiceHourlyResourcePack\":1,\"sendMail\":false}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}import okhttp3.*;
public class Main {
public static void main(String[] args) throws Exception {
OkHttpClient client = new OkHttpClient();
MediaType json = MediaType.get("application/json");
RequestBody body = RequestBody.create("{\"name\":\"Jon Doe\",\"email\":\"jon@doe.com\",\"extRelationId\":1,\"selfService\":3,\"selfServiceHourlyCredit\":true,\"selfServiceHourlyGroupProfiles\":[1,2,3],\"selfServiceResourceGroupProfiles\":[4,5,6],\"selfServiceHourlyResourcePack\":1,\"sendMail\":false}", json);
Request request = new Request.Builder()
.url("https://cp.domain.com/api/v1/users")
.method("POST", body)
.addHeader("Authorization", "Bearer <token>")
.addHeader("Accept", "application/json")
.build();
try (Response response = client.newCall(request).execute()) {
System.out.println(response.code());
System.out.println(response.body().string());
}
}
}using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
var client = new HttpClient();
var request = new HttpRequestMessage(new HttpMethod("POST"), "https://cp.domain.com/api/v1/users");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Content = new StringContent("{\"name\":\"Jon Doe\",\"email\":\"jon@doe.com\",\"extRelationId\":1,\"selfService\":3,\"selfServiceHourlyCredit\":true,\"selfServiceHourlyGroupProfiles\":[1,2,3],\"selfServiceResourceGroupProfiles\":[4,5,6],\"selfServiceHourlyResourcePack\":1,\"sendMail\":false}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());require "net/http"
require "json"
uri = URI("https://cp.domain.com/api/v1/users")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"Jon Doe\",\"email\":\"jon@doe.com\",\"extRelationId\":1,\"selfService\":3,\"selfServiceHourlyCredit\":true,\"selfServiceHourlyGroupProfiles\":[1,2,3],\"selfServiceResourceGroupProfiles\":[4,5,6],\"selfServiceHourlyResourcePack\":1,\"sendMail\":false}"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.code
puts JSON.pretty_generate(JSON.parse(response.body))import Foundation
var request = URLRequest(url: URL(string: "https://cp.domain.com/api/v1/users")!)
request.httpMethod = "POST"
request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = "{\"name\":\"Jon Doe\",\"email\":\"jon@doe.com\",\"extRelationId\":1,\"selfService\":3,\"selfServiceHourlyCredit\":true,\"selfServiceHourlyGroupProfiles\":[1,2,3],\"selfServiceResourceGroupProfiles\":[4,5,6],\"selfServiceHourlyResourcePack\":1,\"sendMail\":false}".data(using: .utf8)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data, error == nil else { print(error ?? "request failed"); return }
print((response as! HTTPURLResponse).statusCode)
print(String(data: data, encoding: .utf8) ?? "")
}
task.resume()// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use reqwest::blocking::Client;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.request(reqwest::Method::POST, "https://cp.domain.com/api/v1/users")
.bearer_auth("<token>")
.header("Accept", "application/json")
.header("Content-Type", "application/json")
.body(r#"{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}"#)
.send()?;
println!("{}", response.status());
let json: serde_json::Value = response.json()?;
println!("{}", serde_json::to_string_pretty(&json)?);
Ok(())
}// Cargo.toml: reqwest = { version = "0.12", features = ["json"] }, tokio = { version = "1", features = ["full"] }, serde_json = "1"
use reqwest::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.request(reqwest::Method::POST, "https://cp.domain.com/api/v1/users")
.bearer_auth("<token>")
.header("Accept", "application/json")
.header("Content-Type", "application/json")
.body(r#"{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}"#)
.send()
.await?;
println!("{}", response.status());
let json: serde_json::Value = response.json().await?;
println!("{}", serde_json::to_string_pretty(&json)?);
Ok(())
}import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
fun main() {
val client = OkHttpClient()
val body = """{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}""".toRequestBody("application/json".toMediaType())
val request = Request.Builder()
.url("https://cp.domain.com/api/v1/users")
.method("POST", body)
.addHeader("Authorization", "Bearer <token>")
.addHeader("Accept", "application/json")
.build()
client.newCall(request).execute().use { response ->
println(response.code)
println(response.body?.string())
}
}// pubspec.yaml: http: ^1.2.0
import 'dart:convert';
import 'package:http/http.dart' as http;
Future<void> main() async {
final request = http.Request('POST', Uri.parse('https://cp.domain.com/api/v1/users'));
request.headers['Authorization'] = 'Bearer <token>';
request.headers['Accept'] = 'application/json';
request.headers['Content-Type'] = 'application/json';
request.body = r'''{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}''';
final response = await http.Response.fromStream(await request.send());
print(response.statusCode);
print(const JsonEncoder.withIndent(' ').convert(jsonDecode(response.body)));
}#include <stdio.h>
#include <curl/curl.h>
int main(void) {
CURL *curl = curl_easy_init();
if (!curl) return 1;
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Accept: application/json");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(curl, CURLOPT_URL, "https://cp.domain.com/api/v1/users");
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"name\":\"Jon Doe\",\"email\":\"jon@doe.com\",\"extRelationId\":1,\"selfService\":3,\"selfServiceHourlyCredit\":true,\"selfServiceHourlyGroupProfiles\":[1,2,3],\"selfServiceResourceGroupProfiles\":[4,5,6],\"selfServiceHourlyResourcePack\":1,\"sendMail\":false}");
CURLcode result = curl_easy_perform(curl);
if (result != CURLE_OK) fprintf(stderr, "%s\n", curl_easy_strerror(result));
curl_slist_free_all(headers);
curl_easy_cleanup(curl);
return result == CURLE_OK ? 0 : 1;
}$headers = @{
Authorization = "Bearer <token>"
Accept = "application/json"
}
$body = @'
{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}
'@
$response = Invoke-RestMethod -Uri "https://cp.domain.com/api/v1/users" -Method POST -Headers $headers -ContentType "application/json" -Body $body
$response | ConvertTo-Json -Depth 10POST /api/v1/users HTTP/1.1
Host: cp.domain.com
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 359
{
"name": "Jon Doe",
"email": "jon@doe.com",
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyCredit": true,
"selfServiceHourlyGroupProfiles": [
1,
2,
3
],
"selfServiceResourceGroupProfiles": [
4,
5,
6
],
"selfServiceHourlyResourcePack": 1,
"sendMail": false
}Responses
201Created.
#
A user account. password is only present in the response to creating a user.
User fields
Self-service level for the user; disabled by default.
| Value | Meaning |
|---|---|
0 | Disabled |
1 | Hourly |
2 | Resource packs |
3 | Hourly and resource packs |
Only returned when the user is created.
{
"data": {
"id": 2,
"admin": false,
"extRelationId": 1,
"selfService": 3,
"selfServiceHourlyGroupProfiles": [],
"selfServiceResourceGroupProfiles": [],
"selfServiceHourlyResourcePack": null,
"name": "Jon Doe",
"email": "jon@doe.com",
"timezone": "Europe/London",
"suspended": false,
"twoFactorAuth": false,
"created": "2025-01-20T12:41:28.000000Z",
"updated": "2025-01-20T12:41:28.000000Z",
"password": "0hPZSAmj8Tgq1noGoenxpxlC9xf1tc"
}
}401The bearer token is missing, invalid, or expired. The response has no body.
#
403The API token does not have the permission this endpoint requires.
#
{
"msg": "the API token does not have the necessary permissions"
}409User with specified email already exists.
#
422Validation failed. errors maps each invalid field to its messages.
#
errors maps each invalid field to its messages.{
"errors": {
"email": [
"The email field is required."
]
}
}429Too many requests. Either the token's requests per minute are used up (see the `X-RateL…
#
Too many requests. Either the token's requests per minute are used up (see the X-RateLimit-* headers) or the calling address has failed authentication 10 times in a minute (the body then includes retry_after_seconds). Retry-After gives the seconds to wait.
Seconds to wait before retrying. Present on the failed-authentication limit only.
Seconds to wait before retrying.
The token's requests per minute (token limit only).
Requests left in the current minute (token limit only).
Unix timestamp at which the minute resets (token limit only).
{
"errors": [
"Too Many Requests"
]
}{
"errors": [
"Too many authentication attempts. Try again later."
],
"retry_after_seconds": 42
}