Skip to main content
POST
/
frontend
/
api
/
v1
/
auth
/
jwt
Generate new JWT Token
curl --request POST \
  --url https://{host}/frontend/api/v1/auth/jwt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "claims": {},
  "long-term-token": true,
  "permissions": [
    "read:billing"
  ],
  "restrictions": [
    "read:billing"
  ]
}
'
import requests

url = "https://{host}/frontend/api/v1/auth/jwt"

payload = {
"claims": {},
"long-term-token": True,
"permissions": ["read:billing"],
"restrictions": ["read:billing"]
}
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({
claims: {},
'long-term-token': true,
permissions: ['read:billing'],
restrictions: ['read:billing']
})
};

fetch('https://{host}/frontend/api/v1/auth/jwt', 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}/frontend/api/v1/auth/jwt",
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([
'claims' => [

],
'long-term-token' => true,
'permissions' => [
'read:billing'
],
'restrictions' => [
'read:billing'
]
]),
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://{host}/frontend/api/v1/auth/jwt"

payload := strings.NewReader("{\n \"claims\": {},\n \"long-term-token\": true,\n \"permissions\": [\n \"read:billing\"\n ],\n \"restrictions\": [\n \"read:billing\"\n ]\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://{host}/frontend/api/v1/auth/jwt")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"claims\": {},\n \"long-term-token\": true,\n \"permissions\": [\n \"read:billing\"\n ],\n \"restrictions\": [\n \"read:billing\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/frontend/api/v1/auth/jwt")

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 \"claims\": {},\n \"long-term-token\": true,\n \"permissions\": [\n \"read:billing\"\n ],\n \"restrictions\": [\n \"read:billing\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "expire": "2023-11-07T05:31:56Z",
  "token": "<string>"
}
{
"code": 123,
"context": {},
"error": "<string>",
"status": "<string>"
}

Authorizations

Authorization
string
header
required

API Key Security (Header).

Body

claims
object

Custom token claims map

long-term-token
boolean
default:true

Expire JWT token in 2 weeks if true and in 3 hours if false

permissions
enum<string>[]

Permissions list

Available options:
read:admin,
read:billing,
read:invite,
read:media,
read:profile,
read:statistics,
read:sub-user,
read:user,
write:admin,
write:billing,
write:invite,
write:media,
write:sub-user,
write:user
restrictions
enum<string>[]

Restrictions list

Available options:
read:admin,
read:billing,
read:invite,
read:media,
read:profile,
read:statistics,
read:sub-user,
read:user,
write:admin,
write:billing,
write:invite,
write:media,
write:sub-user,
write:user

Response

OK

expire
string<date-time>
Example:

"2024-11-01T16:39:02Z"

token
string
Example:

"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy.zzzzzzzzzzzzzzzzzzz-zzzzzzzzzzzzzzzzzzzzzzz"