Create a user
curl --request POST \
--url https://{host}/api/v3/users \
--header 'Content-Type: application/json' \
--header 'X-Qanapi-Authorization: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"password": "<string>",
"name": "<string>",
"role": "user"
}
'import requests
url = "https://{host}/api/v3/users"
payload = {
"email": "jsmith@example.com",
"password": "<string>",
"name": "<string>",
"role": "user"
}
headers = {
"X-Qanapi-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Qanapi-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'jsmith@example.com',
password: '<string>',
name: '<string>',
role: 'user'
})
};
fetch('https://{host}/api/v3/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://{host}/api/v3/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' => 'jsmith@example.com',
'password' => '<string>',
'name' => '<string>',
'role' => 'user'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Qanapi-Authorization: <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://{host}/api/v3/users"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"user\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Qanapi-Authorization", "<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://{host}/api/v3/users")
.header("X-Qanapi-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"user\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v3/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Qanapi-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"user\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"name": "<string>",
"role": "admin",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException",
"errors": {
"type": [
"The type field is required."
],
"configuration_ids": [
"No configuration has the id `...`."
]
}
}Users
Create a user
Requires user:manage. The email address is lowercased and trimmed
before it is stored, and must be unique. role defaults to user, so
naming admin here is a deliberate promotion.
POST
/
api
/
v3
/
users
Create a user
curl --request POST \
--url https://{host}/api/v3/users \
--header 'Content-Type: application/json' \
--header 'X-Qanapi-Authorization: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"password": "<string>",
"name": "<string>",
"role": "user"
}
'import requests
url = "https://{host}/api/v3/users"
payload = {
"email": "jsmith@example.com",
"password": "<string>",
"name": "<string>",
"role": "user"
}
headers = {
"X-Qanapi-Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Qanapi-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'jsmith@example.com',
password: '<string>',
name: '<string>',
role: 'user'
})
};
fetch('https://{host}/api/v3/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://{host}/api/v3/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' => 'jsmith@example.com',
'password' => '<string>',
'name' => '<string>',
'role' => 'user'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Qanapi-Authorization: <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://{host}/api/v3/users"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"user\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Qanapi-Authorization", "<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://{host}/api/v3/users")
.header("X-Qanapi-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"user\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/v3/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Qanapi-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"user\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"name": "<string>",
"role": "admin",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException"
}{
"message": "Unauthorized.",
"error": "InvalidApiKeyException",
"errors": {
"type": [
"The type field is required."
],
"configuration_ids": [
"No configuration has the id `...`."
]
}
}Authorizations
ApiKeyAuthBearerAuth
A machine credential, qk_ followed by its secret. Only a hash of the
secret is stored, so a key is displayed exactly once, when it is created
or rotated. A key reaches only the configurations it is linked to.
It may also be sent as Authorization: Bearer qk_..., which is
recognised by the prefix.
Body
application/json
Response
The new user.
admin is the only role that reaches user, policy and API key
management without an explicit policy statement.
Available options:
admin, user ⌘I