Get version-bound signing metadata for the current user

GET

/api/v1/protected/signing-key

const url = 'https://localhost:8080/api/v1/protected/signing-key';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://localhost:8080/api/v1/protected/signing-key \
  --header 'Authorization: <Authorization>'

Returns a public DID and opaque reference to echo on /api/v1/protected/sign. Also supports service-account users authenticated by existing middleware.

Authorizations

BearerAuth
ApiKeyAuth

Responses

200

application/json

object

algorithm

string

Allowed values: secp256k1 p256

didDocument

The W3C DID document for a key, in did:key form

object

@context

string

assertionMethod

Array<string>

authentication

DID URLs into verificationMethod

Array<string>

string

verificationMethod

Array<object>

A public key in a DID document, published as a JWK

object

controller

string

publicKeyJwk

object

type

string

hashAlgorithm

string

joseAlgorithm

string

purpose

string

signatureEncoding

string

signingKeyReference

string

Example

{
  "algorithm": "secp256k1",
  "didDocument": {
    "@context": "https://www.w3.org/ns/did/v1",
    "id": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
    "verificationMethod": [
      {
        "controller": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
        "id": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme#zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
        "type": "JsonWebSignature2020"
      }
    ]
  }
}

401

Unauthorized

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

The user’s key ID selects reserved platform key material

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404

Not Found

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal Server Error

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

503

Service Unavailable

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}