Add key

POST 
/api/management/keys

Generates a new key based on the provided configuration

Request

application/json

Body

required

typeKeyType (string)required

Possible values: [EdDSA, ES384, X509]

idstringrequired
defaultbooleanrequired
existingKeystring
existingCertificatestring

Responses

200

application/json

Schema

Schema

idstringrequired
typeKeyType (string)required

Possible values: [EdDSA, ES384, X509]

defaultbooleanrequired

publicKey

object

required

algstring

crvstring

estring

extboolean

key_opsstring[]

kidstring

ktystringrequired

nstring

usestring

xstring

ystring
createddate-timerequired
modifieddate-timerequired

Example (from schema)

{
  "id": "string",
  "type": "EdDSA",
  "default": true,
  "publicKey": {
    "alg": "string",
    "crv": "string",
    "e": "string",
    "ext": true,
    "key_ops": [
      "string"
    ],
    "kid": "string",
    "kty": "string",
    "n": "string",
    "use": "string",
    "x": "string",
    "y": "string"
  },
  "created": "2024-07-29T15:51:28.071Z",
  "modified": "2024-07-29T15:51:28.071Z"
}

400

Malformed request

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

{
  "name": "string",
  "status": "string",
  "code": 0,
  "message": {},
  "error": "string"
}

403

Forbidden

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

{
  "name": "string",
  "status": "string",
  "code": 0,
  "message": {},
  "error": "string"
}

409

Resource already exists

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

{
  "name": "string",
  "status": "string",
  "code": 0,
  "message": {},
  "error": "string"
}