Create API key
curl --request POST \
--url http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key_name": "Production API Key",
"scopes": [
"read",
"write"
]
}
'import requests
url = "http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys"
payload = {
"key_name": "Production API Key",
"scopes": ["read", "write"]
}
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({key_name: 'Production API Key', scopes: ['read', 'write']})
};
fetch('http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "9001",
CURLOPT_URL => "http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys",
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([
'key_name' => 'Production API Key',
'scopes' => [
'read',
'write'
]
]),
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 := "http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys"
payload := strings.NewReader("{\n \"key_name\": \"Production API Key\",\n \"scopes\": [\n \"read\",\n \"write\"\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("http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key_name\": \"Production API Key\",\n \"scopes\": [\n \"read\",\n \"write\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key_name\": \"Production API Key\",\n \"scopes\": [\n \"read\",\n \"write\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "apikey-abc123-v1",
"key_name": "Production API Key",
"raw_key": "aion_sk_live_abc123xyz789...",
"scopes": [
"read",
"write"
],
"created_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": {
"code": "AUTH_002",
"type": "unauthorized",
"message": "Invalid or expired authentication token",
"details": "<string>"
}
}{
"success": false,
"error": {
"code": "AUTH_002",
"type": "unauthorized",
"message": "Invalid or expired authentication token",
"details": "<string>"
}
}{
"success": false,
"error": {
"code": "AUTH_002",
"type": "unauthorized",
"message": "Invalid or expired authentication token",
"details": "<string>"
}
}API Keys
Create API key
Creates a new API key for machine-to-machine authentication.
Important: The raw key value is only returned once in this response. Store it securely as it cannot be retrieved again.
Authentication: Requires valid JWT. User can only create keys for themselves.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
users
/
{user_id}
/
keys
Create API key
curl --request POST \
--url http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key_name": "Production API Key",
"scopes": [
"read",
"write"
]
}
'import requests
url = "http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys"
payload = {
"key_name": "Production API Key",
"scopes": ["read", "write"]
}
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({key_name: 'Production API Key', scopes: ['read', 'write']})
};
fetch('http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "9001",
CURLOPT_URL => "http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys",
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([
'key_name' => 'Production API Key',
'scopes' => [
'read',
'write'
]
]),
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 := "http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys"
payload := strings.NewReader("{\n \"key_name\": \"Production API Key\",\n \"scopes\": [\n \"read\",\n \"write\"\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("http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key_name\": \"Production API Key\",\n \"scopes\": [\n \"read\",\n \"write\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9001/api/v1/accounts/{account_id}/users/{user_id}/keys")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key_name\": \"Production API Key\",\n \"scopes\": [\n \"read\",\n \"write\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "apikey-abc123-v1",
"key_name": "Production API Key",
"raw_key": "aion_sk_live_abc123xyz789...",
"scopes": [
"read",
"write"
],
"created_at": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"error": {
"code": "AUTH_002",
"type": "unauthorized",
"message": "Invalid or expired authentication token",
"details": "<string>"
}
}{
"success": false,
"error": {
"code": "AUTH_002",
"type": "unauthorized",
"message": "Invalid or expired authentication token",
"details": "<string>"
}
}{
"success": false,
"error": {
"code": "AUTH_002",
"type": "unauthorized",
"message": "Invalid or expired authentication token",
"details": "<string>"
}
}Authorizations
JWT token from Auth0
Path Parameters
Account's external ID (format: acct-xxx-v1)
Example:
"acct-xyz789-v1"
User's external ID (format: user-xxx-v1)
Example:
"user-abc123-v1"
Body
application/json
⌘I
