Get DID key information

GET

/api/v1/auth/did-key/{keyId}

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

Retrieve information for one of the authenticated user’s DID keys from the configured key provider

Authorizations

BearerAuth
ApiKeyAuth

Parameters

Path Parameters

keyId

required

string

Provider key ID (e.g., auth0-abc123), not the did:key:… value

Responses

200

DID key information

application/json

object

createdAt

string

didDocument

object

@context

Array

alsoKnownAs

Array<object>

object

forceQuery

Append a query (’?’) even if RawQuery is empty

boolean

fragment

Fragment for references, without ’#’

string

host

Host or host:port (see Hostname and Port methods)

string

omitHost

Do not emit empty host (authority)

boolean

opaque

Encoded opaque data

string

path

Path (relative paths may omit leading slash)

string

rawFragment

Encoded fragment hint (see EscapedFragment method)

string

rawPath

Encoded path hint (see EscapedPath method)

string

rawQuery

Encoded query values, without ’?’

string

scheme

string

user

Username and password information

object

assertionMethod

Array<object>

object

controller

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

object

decodedFragment

DecodedFragment is the DID fragment without the leading ’#’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedPath

DecodedPath is the DID path without the leading ’/’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

fragment

Fragment is the DID fragment without the leading ’#’, in escaped form.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

path

Path is the DID path without the leading ’/’, in escaped form.

string

query

Query contains the DID query key-value pairs, in unescaped form. String() will escape the values again, and order the keys alphabetically.

object

publicKeyBase58

PublicKeyBase58 is deprecated and should not be used anymore. Use PublicKeyMultibase or PublicKeyJwk instead.

string

publicKeyJwk

object

key

additional properties

any

publicKeyMultibase

string

type

string

Allowed values: JsonWebKey2020 Ed25519VerificationKey2018 Ed25519VerificationKey2020 EcdsaSecp256k1VerificationKey2019 RsaVerificationKey2018

authentication

Array<object>

object

controller

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

object

decodedFragment

DecodedFragment is the DID fragment without the leading ’#’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedPath

DecodedPath is the DID path without the leading ’/’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

fragment

Fragment is the DID fragment without the leading ’#’, in escaped form.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

path

Path is the DID path without the leading ’/’, in escaped form.

string

query

Query contains the DID query key-value pairs, in unescaped form. String() will escape the values again, and order the keys alphabetically.

object

publicKeyBase58

PublicKeyBase58 is deprecated and should not be used anymore. Use PublicKeyMultibase or PublicKeyJwk instead.

string

publicKeyJwk

object

key

additional properties

any

publicKeyMultibase

string

type

string

Allowed values: JsonWebKey2020 Ed25519VerificationKey2018 Ed25519VerificationKey2020 EcdsaSecp256k1VerificationKey2019 RsaVerificationKey2018

capabilityDelegation

Array<object>

object

controller

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

object

decodedFragment

DecodedFragment is the DID fragment without the leading ’#’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedPath

DecodedPath is the DID path without the leading ’/’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

fragment

Fragment is the DID fragment without the leading ’#’, in escaped form.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

path

Path is the DID path without the leading ’/’, in escaped form.

string

query

Query contains the DID query key-value pairs, in unescaped form. String() will escape the values again, and order the keys alphabetically.

object

publicKeyBase58

PublicKeyBase58 is deprecated and should not be used anymore. Use PublicKeyMultibase or PublicKeyJwk instead.

string

publicKeyJwk

object

key

additional properties

any

publicKeyMultibase

string

type

string

Allowed values: JsonWebKey2020 Ed25519VerificationKey2018 Ed25519VerificationKey2020 EcdsaSecp256k1VerificationKey2019 RsaVerificationKey2018

capabilityInvocation

Array<object>

object

controller

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

object

decodedFragment

DecodedFragment is the DID fragment without the leading ’#’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedPath

DecodedPath is the DID path without the leading ’/’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

fragment

Fragment is the DID fragment without the leading ’#’, in escaped form.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

path

Path is the DID path without the leading ’/’, in escaped form.

string

query

Query contains the DID query key-value pairs, in unescaped form. String() will escape the values again, and order the keys alphabetically.

object

publicKeyBase58

PublicKeyBase58 is deprecated and should not be used anymore. Use PublicKeyMultibase or PublicKeyJwk instead.

string

publicKeyJwk

object

key

additional properties

any

publicKeyMultibase

string

type

string

Allowed values: JsonWebKey2020 Ed25519VerificationKey2018 Ed25519VerificationKey2020 EcdsaSecp256k1VerificationKey2019 RsaVerificationKey2018

controller

Array<object>

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

keyAgreement

Array<object>

object

controller

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

object

decodedFragment

DecodedFragment is the DID fragment without the leading ’#’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedPath

DecodedPath is the DID path without the leading ’/’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

fragment

Fragment is the DID fragment without the leading ’#’, in escaped form.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

path

Path is the DID path without the leading ’/’, in escaped form.

string

query

Query contains the DID query key-value pairs, in unescaped form. String() will escape the values again, and order the keys alphabetically.

object

publicKeyBase58

PublicKeyBase58 is deprecated and should not be used anymore. Use PublicKeyMultibase or PublicKeyJwk instead.

string

publicKeyJwk

object

key

additional properties

any

publicKeyMultibase

string

type

string

Allowed values: JsonWebKey2020 Ed25519VerificationKey2018 Ed25519VerificationKey2020 EcdsaSecp256k1VerificationKey2019 RsaVerificationKey2018

service

Array<object>

object

forceQuery

Append a query (’?’) even if RawQuery is empty

boolean

fragment

Fragment for references, without ’#’

string

host

Host or host:port (see Hostname and Port methods)

string

omitHost

Do not emit empty host (authority)

boolean

opaque

Encoded opaque data

string

path

Path (relative paths may omit leading slash)

string

rawFragment

Encoded fragment hint (see EscapedFragment method)

string

rawPath

Encoded path hint (see EscapedPath method)

string

rawQuery

Encoded query values, without ’?’

string

scheme

string

user

Username and password information

object

serviceEndpoint

type

string

verificationMethod

Array<object>

object

controller

object

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

object

decodedFragment

DecodedFragment is the DID fragment without the leading ’#’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedID

DecodedID is the method-specific ID, in unescaped form. It is only set during parsing, and not used by the String() method.

string

decodedPath

DecodedPath is the DID path without the leading ’/’, in unescaped form. It is only set during parsing, and not used by the String() method.

string

fragment

Fragment is the DID fragment without the leading ’#’, in escaped form.

string

ID is the method-specific ID, in escaped form.

string

method

Method is the DID method, e.g. “example”.

string

path

Path is the DID path without the leading ’/’, in escaped form.

string

query

Query contains the DID query key-value pairs, in unescaped form. String() will escape the values again, and order the keys alphabetically.

object

publicKeyBase58

PublicKeyBase58 is deprecated and should not be used anymore. Use PublicKeyMultibase or PublicKeyJwk instead.

string

publicKeyJwk

object

key

additional properties

any

publicKeyMultibase

string

type

string

Allowed values: JsonWebKey2020 Ed25519VerificationKey2018 Ed25519VerificationKey2020 EcdsaSecp256k1VerificationKey2019 RsaVerificationKey2018

keyId

string

keyReference

string

keyVaultUrl

Deprecated: use keyReference

string

provider

string

publicKey

string

Example

{
  "didDocument": {
    "assertionMethod": [
      {
        "type": "JsonWebKey2020"
      }
    ],
    "authentication": [
      {
        "type": "JsonWebKey2020"
      }
    ],
    "capabilityDelegation": [
      {
        "type": "JsonWebKey2020"
      }
    ],
    "capabilityInvocation": [
      {
        "type": "JsonWebKey2020"
      }
    ],
    "keyAgreement": [
      {
        "type": "JsonWebKey2020"
      }
    ],
    "verificationMethod": [
      {
        "type": "JsonWebKey2020"
      }
    ]
  }
}

400

Bad request - Key ID required

application/json

object

error

string

error_description

string

Example

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

401

Unauthorized

application/json

object

error

string

error_description

string

Example

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

403

Forbidden - May only access your own DID keys

application/json

object

error

string

error_description

string

Example

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

500

Internal server error

application/json

object

error

string

error_description

string

Example

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