API keys
Create a new API key
Provisions a new M2M application in Auth0 and returns credentials. The client secret is only shown once.
POST
/
v1
/
api-keys
Create a new API key
curl --request POST \
--url https://api.example.com/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production Integration",
"access": "write",
"description": "API key for production payment processing"
}
'import requests
url = "https://api.example.com/v1/api-keys"
payload = {
"name": "Production Integration",
"access": "write",
"description": "API key for production payment processing"
}
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({
name: 'Production Integration',
access: 'write',
description: 'API key for production payment processing'
})
};
fetch('https://api.example.com/v1/api-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_URL => "https://api.example.com/v1/api-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([
'name' => 'Production Integration',
'access' => 'write',
'description' => 'API key for production payment processing'
]),
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://api.example.com/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Production Integration\",\n \"access\": \"write\",\n \"description\": \"API key for production payment processing\"\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://api.example.com/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Integration\",\n \"access\": \"write\",\n \"description\": \"API key for production payment processing\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/api-keys")
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 \"name\": \"Production Integration\",\n \"access\": \"write\",\n \"description\": \"API key for production payment processing\"\n}"
response = http.request(request)
puts response.read_body{
"audience": "https://api.zuba.com",
"clientId": "abc123xyz456",
"clientSecret": "secret_key_here",
"createdAt": "<string>",
"domain": "your-tenant.auth0.com",
"name": "Production Integration",
"description": "<string>"
}Authorizations
Enter Auth0 JWT token
Body
application/json
Name for the API key
Example:
"Production Integration"
Access mode: 'read' mints a read-only key (read:* scopes only); 'write' (default) grants every user-assignable scope.
Available options:
read, write Description of what this API key will be used for
Example:
"API key for production payment processing"
Response
API key created successfully
API audience/identifier
Example:
"https://api.zuba.com"
Auth0 client ID (use this as the API key)
Example:
"abc123xyz456"
Client secret (only shown once during creation)
Example:
"secret_key_here"
Creation timestamp
Auth0 domain for token endpoint
Example:
"your-tenant.auth0.com"
Name of the API key
Example:
"Production Integration"
Description
⌘I
Create a new API key
curl --request POST \
--url https://api.example.com/v1/api-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production Integration",
"access": "write",
"description": "API key for production payment processing"
}
'import requests
url = "https://api.example.com/v1/api-keys"
payload = {
"name": "Production Integration",
"access": "write",
"description": "API key for production payment processing"
}
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({
name: 'Production Integration',
access: 'write',
description: 'API key for production payment processing'
})
};
fetch('https://api.example.com/v1/api-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_URL => "https://api.example.com/v1/api-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([
'name' => 'Production Integration',
'access' => 'write',
'description' => 'API key for production payment processing'
]),
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://api.example.com/v1/api-keys"
payload := strings.NewReader("{\n \"name\": \"Production Integration\",\n \"access\": \"write\",\n \"description\": \"API key for production payment processing\"\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://api.example.com/v1/api-keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production Integration\",\n \"access\": \"write\",\n \"description\": \"API key for production payment processing\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/api-keys")
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 \"name\": \"Production Integration\",\n \"access\": \"write\",\n \"description\": \"API key for production payment processing\"\n}"
response = http.request(request)
puts response.read_body{
"audience": "https://api.zuba.com",
"clientId": "abc123xyz456",
"clientSecret": "secret_key_here",
"createdAt": "<string>",
"domain": "your-tenant.auth0.com",
"name": "Production Integration",
"description": "<string>"
}