curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent": {
    "action": "register",
    "consentedAt": "2023-11-07T05:31:56Z",
    "environmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "publicSigningKey": "<string>",
    "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f"
  },
  "consentSignature": "<string>",
  "publicSigningKey": "<string>",
  "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f",
  "label": "<string>"
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys"

payload = {
    "consent": {
        "action": "register",
        "consentedAt": "2023-11-07T05:31:56Z",
        "environmentId": "95b11417-f18f-457f-8804-68e361f9164f",
        "publicSigningKey": "<string>",
        "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f"
    },
    "consentSignature": "<string>",
    "publicSigningKey": "<string>",
    "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f",
    "label": "<string>"
}
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({
    consent: {
      action: 'register',
      consentedAt: '2023-11-07T05:31:56Z',
      environmentId: '95b11417-f18f-457f-8804-68e361f9164f',
      publicSigningKey: '<string>',
      serverIdentifier: '95b11417-f18f-457f-8804-68e361f9164f'
    },
    consentSignature: '<string>',
    publicSigningKey: '<string>',
    serverIdentifier: '95b11417-f18f-457f-8804-68e361f9164f',
    label: '<string>'
  })
};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/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://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/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([
    'consent' => [
        'action' => 'register',
        'consentedAt' => '2023-11-07T05:31:56Z',
        'environmentId' => '95b11417-f18f-457f-8804-68e361f9164f',
        'publicSigningKey' => '<string>',
        'serverIdentifier' => '95b11417-f18f-457f-8804-68e361f9164f'
    ],
    'consentSignature' => '<string>',
    'publicSigningKey' => '<string>',
    'serverIdentifier' => '95b11417-f18f-457f-8804-68e361f9164f',
    'label' => '<string>'
  ]),
  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://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys"

	payload := strings.NewReader("{\n  \"consent\": {\n    \"action\": \"register\",\n    \"consentedAt\": \"2023-11-07T05:31:56Z\",\n    \"environmentId\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n    \"publicSigningKey\": \"<string>\",\n    \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\"\n  },\n  \"consentSignature\": \"<string>\",\n  \"publicSigningKey\": \"<string>\",\n  \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n  \"label\": \"<string>\"\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://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consent\": {\n    \"action\": \"register\",\n    \"consentedAt\": \"2023-11-07T05:31:56Z\",\n    \"environmentId\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n    \"publicSigningKey\": \"<string>\",\n    \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\"\n  },\n  \"consentSignature\": \"<string>\",\n  \"publicSigningKey\": \"<string>\",\n  \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n  \"label\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/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  \"consent\": {\n    \"action\": \"register\",\n    \"consentedAt\": \"2023-11-07T05:31:56Z\",\n    \"environmentId\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n    \"publicSigningKey\": \"<string>\",\n    \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\"\n  },\n  \"consentSignature\": \"<string>\",\n  \"publicSigningKey\": \"<string>\",\n  \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n  \"label\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f",
  "kid": "<string>",
  "label": "<string>",
  "publicSigningKey": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden",
  "code": "sanctions_blocked"
}

{
  "error": "Not Found",
  "code": "not_found"
}

{
  "error": "Conflict: invalid state transition"
}

{
  "error": "Conflict: invalid state transition"
}

{
  "error": "Internal Server Error"
}

{
  "error": "<string>",
  "code": "<string>"
}

Register a Server Signing Key for a server identity

Registers a P-256 public key for the server signer named by the admin’s signed consent, creating the signer if needed. auth-service verifies the consent, so a key the admin did not consent to cannot be registered. Dashboard admin JWT only. Registering the same key again returns it. An identifier used by another environment’s signer is a 409, and revoked keys cannot be re-registered. An invalid consent (malformed, older than 5 minutes, unverified or mismatched) is a 400, with the reason in code.

POST

environments

{environmentId}

serverSigning

keys

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent": {
    "action": "register",
    "consentedAt": "2023-11-07T05:31:56Z",
    "environmentId": "95b11417-f18f-457f-8804-68e361f9164f",
    "publicSigningKey": "<string>",
    "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f"
  },
  "consentSignature": "<string>",
  "publicSigningKey": "<string>",
  "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f",
  "label": "<string>"
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys"

payload = {
    "consent": {
        "action": "register",
        "consentedAt": "2023-11-07T05:31:56Z",
        "environmentId": "95b11417-f18f-457f-8804-68e361f9164f",
        "publicSigningKey": "<string>",
        "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f"
    },
    "consentSignature": "<string>",
    "publicSigningKey": "<string>",
    "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f",
    "label": "<string>"
}
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({
    consent: {
      action: 'register',
      consentedAt: '2023-11-07T05:31:56Z',
      environmentId: '95b11417-f18f-457f-8804-68e361f9164f',
      publicSigningKey: '<string>',
      serverIdentifier: '95b11417-f18f-457f-8804-68e361f9164f'
    },
    consentSignature: '<string>',
    publicSigningKey: '<string>',
    serverIdentifier: '95b11417-f18f-457f-8804-68e361f9164f',
    label: '<string>'
  })
};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/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://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/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([
    'consent' => [
        'action' => 'register',
        'consentedAt' => '2023-11-07T05:31:56Z',
        'environmentId' => '95b11417-f18f-457f-8804-68e361f9164f',
        'publicSigningKey' => '<string>',
        'serverIdentifier' => '95b11417-f18f-457f-8804-68e361f9164f'
    ],
    'consentSignature' => '<string>',
    'publicSigningKey' => '<string>',
    'serverIdentifier' => '95b11417-f18f-457f-8804-68e361f9164f',
    'label' => '<string>'
  ]),
  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://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys"

	payload := strings.NewReader("{\n  \"consent\": {\n    \"action\": \"register\",\n    \"consentedAt\": \"2023-11-07T05:31:56Z\",\n    \"environmentId\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n    \"publicSigningKey\": \"<string>\",\n    \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\"\n  },\n  \"consentSignature\": \"<string>\",\n  \"publicSigningKey\": \"<string>\",\n  \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n  \"label\": \"<string>\"\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://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consent\": {\n    \"action\": \"register\",\n    \"consentedAt\": \"2023-11-07T05:31:56Z\",\n    \"environmentId\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n    \"publicSigningKey\": \"<string>\",\n    \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\"\n  },\n  \"consentSignature\": \"<string>\",\n  \"publicSigningKey\": \"<string>\",\n  \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n  \"label\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/serverSigning/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  \"consent\": {\n    \"action\": \"register\",\n    \"consentedAt\": \"2023-11-07T05:31:56Z\",\n    \"environmentId\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n    \"publicSigningKey\": \"<string>\",\n    \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\"\n  },\n  \"consentSignature\": \"<string>\",\n  \"publicSigningKey\": \"<string>\",\n  \"serverIdentifier\": \"95b11417-f18f-457f-8804-68e361f9164f\",\n  \"label\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "serverIdentifier": "95b11417-f18f-457f-8804-68e361f9164f",
  "kid": "<string>",
  "label": "<string>",
  "publicSigningKey": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden",
  "code": "sanctions_blocked"
}

{
  "error": "Not Found",
  "code": "not_found"
}

{
  "error": "Conflict: invalid state transition"
}

{
  "error": "Conflict: invalid state transition"
}

{
  "error": "Internal Server Error"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId

string

required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

publicSigningKey and serverIdentifier must equal the ones in the signed consent.

What the env admin signs to enroll a server's key.

Show child attributes

The admin's signature over consent

Minimum string length: 1

publicSigningKey

string

required

P-256 public key as SEC1 hex, compressed (33 bytes) or uncompressed (65 bytes)

Pattern: ^(0[23][0-9a-fA-F]{64}|04[0-9a-fA-F]{128})$

serverIdentifier

string

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

label

string | null

Maximum string length: 255

Response

The registered key

string

required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

serverIdentifier

string

required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

kid

string

required

RFC 7638 thumbprint of the public key; the JWS kid of operation proofs

label

string | null

required

publicSigningKey

string

required

status

enum<string>

required

Available options:

active,

expired,

revoked

createdAt

string<date-time>

required

revokedAt

string<date-time> | null

required

Overview

Endpoints

Schemas

Register a Server Signing Key for a server identity

Authorizations

Path Parameters

Body

Response