Set Login PIN
curl --request PUT \
--url https://api.xenia.team/api/v1/mgt/set-login-pin \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"userId": "e25dd448-7ae7-4588-8767-7e1a316547e5",
"pin": "123456"
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/set-login-pin"
payload = {
"userId": "e25dd448-7ae7-4588-8767-7e1a316547e5",
"pin": "123456"
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({userId: 'e25dd448-7ae7-4588-8767-7e1a316547e5', pin: '123456'})
};
fetch('https://api.xenia.team/api/v1/mgt/set-login-pin', 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.xenia.team/api/v1/mgt/set-login-pin",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'userId' => 'e25dd448-7ae7-4588-8767-7e1a316547e5',
'pin' => '123456'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <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.xenia.team/api/v1/mgt/set-login-pin"
payload := strings.NewReader("{\n \"userId\": \"e25dd448-7ae7-4588-8767-7e1a316547e5\",\n \"pin\": \"123456\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<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.put("https://api.xenia.team/api/v1/mgt/set-login-pin")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"e25dd448-7ae7-4588-8767-7e1a316547e5\",\n \"pin\": \"123456\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/set-login-pin")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"e25dd448-7ae7-4588-8767-7e1a316547e5\",\n \"pin\": \"123456\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"extra_meta": {
"message": "PIN set successfully"
}
}Users
Set User Login Pin
Sets a PIN (4 to 6 digits) for the user identified by userId in the body. There are no path parameters; the user and workspace are taken from the body and the API key respectively. The key’s user must hold both CAN_MANAGE_USERS and CAN_MANAGE_USERS_PASSWORD — otherwise the call returns 403.
PUT
/
api
/
v1
/
mgt
/
set-login-pin
Set Login PIN
curl --request PUT \
--url https://api.xenia.team/api/v1/mgt/set-login-pin \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"userId": "e25dd448-7ae7-4588-8767-7e1a316547e5",
"pin": "123456"
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/set-login-pin"
payload = {
"userId": "e25dd448-7ae7-4588-8767-7e1a316547e5",
"pin": "123456"
}
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({userId: 'e25dd448-7ae7-4588-8767-7e1a316547e5', pin: '123456'})
};
fetch('https://api.xenia.team/api/v1/mgt/set-login-pin', 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.xenia.team/api/v1/mgt/set-login-pin",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'userId' => 'e25dd448-7ae7-4588-8767-7e1a316547e5',
'pin' => '123456'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <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.xenia.team/api/v1/mgt/set-login-pin"
payload := strings.NewReader("{\n \"userId\": \"e25dd448-7ae7-4588-8767-7e1a316547e5\",\n \"pin\": \"123456\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<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.put("https://api.xenia.team/api/v1/mgt/set-login-pin")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"e25dd448-7ae7-4588-8767-7e1a316547e5\",\n \"pin\": \"123456\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/set-login-pin")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"e25dd448-7ae7-4588-8767-7e1a316547e5\",\n \"pin\": \"123456\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"extra_meta": {
"message": "PIN set successfully"
}
}The key’s user must hold both
CAN_MANAGE_USERS and CAN_MANAGE_USERS_PASSWORD. Setting a login PIN lets that user sign in via PIN, so this is treated as a privileged, admin-only action (same as resetting a password) — a key without those permissions gets a 403.Authorizations
Client API key for authentication
Client secret for authentication
Body
application/json