List user's DID keys

GET

/api/v1/auth/users/{userId}/did-keys

const url = 'https://localhost:8080/api/v1/auth/users/example/did-keys';
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/auth/users/example/did-keys \
  --header 'Authorization: <Authorization>'

List all DID keys associated with a user; callers may only list their own keys

Authorizations

BearerAuth
ApiKeyAuth

Parameters

Path Parameters

userId

required

string

User UUID (bare or urn:uuid) or did:key

Responses

200

List of DID keys

application/json

The DID keys held for the authenticated caller

object

keys

Array<object>

A DID key held for a user, described independently of the KMS backing it

object

createdAt

string format: date-time

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

keyId

string

keyReference

string

keyVaultUrl

Deprecated: use keyReference

string

provider

string

publicKey

string

Example

{
  "keys": [
    {
      "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"
          }
        ]
      }
    }
  ]
}

400

Bad request - User ID required

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"
}

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

Forbidden - May only access your own DID keys

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

User 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"
}