Asymmetric

get /keyvault/api/v1/asymmetric

Lists the asymmetric keys.

Authorization

string

required

Default: "Basic base64-encoded-string"

Response

ExamplesSchema

Successful response, returns list of asymmetric keys.

{
  "count": 123,
  "items": [
    {
      "name": "string",
      "id": "string",
      "type": "string",
      "size": 123
    }
  ]
}

post /keyvault/api/v1/asymmetric

Create asymmetric key based on the given key parameters.

name

string

ownerid

string

public

boolean

exportable

boolean

algorithm

string

Enum: RSA
DSA
ECDSA

size

string

data

string

Optional base64 encoded key data. If empty a new keypair will be generated, otherwise the key will be imported to keyvault.

Request

{
  "name": "string",
  "ownerid": "string",
  "public": true,
  "exportable": true,
  "algorithm": "RSA",
  "size": "string",
  "data": "string"
}

Response

ExamplesSchema

Asymmetric key created successfully. Returns public key.

{
  "id": "string"
}

post /keyvault/api/v1/asymmetric/search

Returns the asymmetric keys matching the given search criteria.

name

string

owner_id

string

Request

{
  "name": "string",
  "owner_id": "string"
}

Response

ExamplesSchema

Successful response, returns list of matching asymmetric keys.

{
  "count": 123,
  "items": [
    {
      "name": "string",
      "id": "string",
      "type": "string",
      "size": 123
    }
  ]
}

post /keyvault/api/v1/asymmetric/get

Returns the asymmetric keys matching the given search criteria.

name

string

owner_id

string

Request

{
  "name": "string",
  "owner_id": "string"
}

Response

ExamplesSchema

Successful response, returns list of matching asymmetric keys.

{
  "count": 123,
  "items": [
    {
      "name": "string",
      "id": "string",
      "type": "string",
      "size": 123
    }
  ]
}

get /keyvault/api/v1/asymmetric/{id}

Returns the asymmetric key matching the given ID.

id

string

required

The key ID.

Response

ExamplesSchema

Successful response, returns matching asymmetric key public key.

{
  "name": "string",
  "id": "string",
  "type": "string",
  "size": 123
}

delete /keyvault/api/v1/asymmetric/{id}

Remove the key matching the given ID.

id

string

required

The key ID.

Response

ExamplesSchema

Key successfully removed.

"string"

post /keyvault/api/v1/asymmetric/{id}/sign

Signs the provided data.

data

string

algorithm

string

Enum: SHA1withRSA
SHA256withRSA
SHA384withRSA
SHA512withRSA
SHA1withDSA
SHA2withECDSA

op

string

Enum: signhash
signdata
signssh
sign

Request

{
  "data": "string",
  "algorithm": "SHA1withRSA",
  "op": "signhash"
}

Response

ExamplesSchema

Successfully signed.

{
  "data": "string"
}

get /keyvault/api/v1/asymmetric/{id}/asn1

Converts the key to ASN.1 DER encoded form.

id

string

required

The key ID.

Response

ExamplesSchema

Returns the key in ASN.1 DER encoded form.

{
  "data": "string"
}