Cryptographic keys

The following key management functions are available:

• list - list of key ids

• load - load the public key in JWK format

• delete - delete key

• generate - generate key

• import - import key

• export - export key

List key ids

The /v1/key endpoint lists the available key ids.

curl

curl -X 'GET' \
  'https://core.ssikit.walt.id/v1/key' \
  -H 'accept: application/json'

Request body schema

Response body schema

E.g. List the available key ids.

curl

curl -X 'GET' \
  'https://core.ssikit.walt.id/v1/key' \
  -H 'accept: application/json'

Response body

Load key

The /v1/key/{id} endpoint loads the public component of the provided key id in JWK format:

• id - path parameter (required) - the key id

curl

curl -X 'GET' \
  'https://core.ssikit.walt.id/v1/key/{id}' \
  -H 'accept: application/json'

Request body schema

Response body schema

E.g. Load the key having id = e548f032cadf4145ab6886a57c2e87e6.

curl

curl -X 'GET' \
  'https://core.ssikit.walt.id/v1/key/e548f032cadf4145ab6886a57c2e87e6' \
  -H 'accept: application/json'

Response body

Delete key

The /v1/key/{id} endpoint deletes the specified key.

curl

curl -X 'DELETE' \
  'https://core.ssikit.walt.id/v1/key/' \
  -H 'accept: application/json' \
  -H 'Content-Type: text/plain' \
  -d '<request-body>'

Request body schema

Response body schema

E.g. Delete the key having id = e548f032cadf4145ab6886a57c2e87e6.

curl

curl -X 'DELETE' \
  'https://core.ssikit.walt.id/v1/key/' \
  -H 'accept: application/json' \
  -H 'Content-Type: text/plain' \
  -d 'e548f032cadf4145ab6886a57c2e87e6'

Request body

Generate key

The /v1/key/gen generates a new key using the specified algorithm.

curl

curl -X 'POST' \
  'https://core.ssikit.walt.id/v1/key/gen' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '<request-body>'

Request body schema

Response body schema

E.g. Generate a new key using the EdDSA_Ed25519 algorithm.

curl

curl -X 'POST' \
  'https://core.ssikit.walt.id/v1/key/gen' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "keyAlgorithm": "EdDSA_Ed25519"
}'

Request body

Response body

Import key

The /v1/key/import endpoint imports a key (JWK or PEM format) to the underlying keystore.

curl

curl -X 'POST' \
  'https://core.ssikit.walt.id/v1/key/import' \
  -H 'accept: application/json' \
  -H 'Content-Type: text/plain' \
  -d '<request-body>'

Request body schema

Response body schema

E.g. Import a public key specified in JWK format.

curl

curl -X 'POST' \
  'https://core.ssikit.walt.id/v1/key/import' \
  -H 'accept: application/json' \
  -H 'Content-Type: text/plain' \
  -d '{"kty":"OKP","use":"sig","crv":"Ed25519","kid":"bc6fa6b0593648238c4616800bed7746","x":"YyswAyRO2Aur8Jmzc8aOvI3AWFka3ZynJwB84a0FJVU","alg":"EdDSA"}'

Request body

Response body

Export key

The /v1/key/export endpoint exports public and private key part (if supported by underlying keystore).

curl

curl -X 'POST' \
  'https://core.ssikit.walt.id/v1/key/export' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '<request-body>'

Request body schema

Response body schema

E.g. Export the public key with id = bc6fa6b0593648238c4616800bed7746 as JWK.

curl

curl -X 'POST' \
  'https://core.ssikit.walt.id/v1/key/export' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "keyAlias": "bc6fa6b0593648238c4616800bed7746",
  "format": "JWK",
  "exportPrivate": false
}'

Request body

Response body