Request an actor-key challenge
curl --request POST \
--url https://{host}/v1/auth/challenges \
--header 'Content-Type: application/json' \
--data '
{
"actorId": "<string>",
"keyId": "<string>"
}
'import requests
url = "https://{host}/v1/auth/challenges"
payload = {
"actorId": "<string>",
"keyId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({actorId: '<string>', keyId: '<string>'})
};
fetch('https://{host}/v1/auth/challenges', 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}/v1/auth/challenges",
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([
'actorId' => '<string>',
'keyId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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}/v1/auth/challenges"
payload := strings.NewReader("{\n \"actorId\": \"<string>\",\n \"keyId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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}/v1/auth/challenges")
.header("Content-Type", "application/json")
.body("{\n \"actorId\": \"<string>\",\n \"keyId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/auth/challenges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"actorId\": \"<string>\",\n \"keyId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"actorId": "<string>",
"keyId": "<string>",
"audience": "<string>",
"nonce": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"signingPayload": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "request authentication failed"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Authentication
Request an actor-key challenge
Creates a short-lived, one-time challenge for a pre-registered Ed25519 actor key.
POST
/
v1
/
auth
/
challenges
Request an actor-key challenge
curl --request POST \
--url https://{host}/v1/auth/challenges \
--header 'Content-Type: application/json' \
--data '
{
"actorId": "<string>",
"keyId": "<string>"
}
'import requests
url = "https://{host}/v1/auth/challenges"
payload = {
"actorId": "<string>",
"keyId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({actorId: '<string>', keyId: '<string>'})
};
fetch('https://{host}/v1/auth/challenges', 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}/v1/auth/challenges",
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([
'actorId' => '<string>',
'keyId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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}/v1/auth/challenges"
payload := strings.NewReader("{\n \"actorId\": \"<string>\",\n \"keyId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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}/v1/auth/challenges")
.header("Content-Type", "application/json")
.body("{\n \"actorId\": \"<string>\",\n \"keyId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/auth/challenges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"actorId\": \"<string>\",\n \"keyId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"actorId": "<string>",
"keyId": "<string>",
"audience": "<string>",
"nonce": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"signingPayload": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "request authentication failed"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Body
application/json
Response
Challenge created. Decode and sign signingPayload exactly.
Unpadded base64url nonce; repeat it during exchange.
Unpadded base64url bytes to sign directly with the registered Ed25519 private key.