symmetric

Download Spec

get /keyvault/api/v1/symmetric

Lists the symmetric keys.

Authorization

string

required

Default
"Basic base64-encoded-string"

Response

ExamplesSchema

Successful response, returns list of symmetric keys.

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

post /keyvault/api/v1/symmetric

Create symmetric key based on the given key parameters.

name

string

ownerid

string

flags

int

size

string

data

string

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

Request

{
  "name": "string",
  "ownerid": "string",
  "flags": 123,
  "size": "string",
  "data": "string"
}

Response

ExamplesSchema

Symmetric key created successfully.

{
  "id": "string"
}

post /keyvault/api/v1/symmetric/search

Returns the symmetric 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 symmetric keys.

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

post /keyvault/api/v1/symmetric/get

Returns the symmetric keys matching name.

name

string

owner_id

string

Request

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

Response

ExamplesSchema

Successful response, returns list of matching symmetric keys.

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

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

Returns the symmetric key matching the given ID.

id

string

required

The key ID.

Response

ExamplesSchema

Successful response, returns matching symmetric key.

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

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

Remove the key matching the given ID.

id

string

required

The key ID.

Response

ExamplesSchema

Key successfully removed.

"string"

post /keyvault/api/v1/symmetric/{id}/hmac

Computes HMAC of the data using the specified algorithm.

data

string

algorithm

string

Request

{
  "data": "string",
  "algorithm": "string"
}

Response

ExamplesSchema

Returns computed HMAC.

{
  "data": "string"
}

post /keyvault/api/v1/symmetric/{id}/seal

Encrypts and authenticates the data with the specified cipher algorithm. The optional additionalData contains additional data to be included in the data authentication.

data

string

algorithm

string

additionalData

string

Request

{
  "data": "string",
  "algorithm": "string",
  "additionalData": "string"
}

Response

ExamplesSchema

Successful, returns cipher text.

{
  "cipher": "string"
}

post /keyvault/api/v1/symmetric/{id}/open

Decrypts and verifies the authentication of the cipher text.

algorithm

string

cipher

string

additionalData

string

Request

{
  "algorithm": "string",
  "cipher": "string",
  "additionalData": "string"
}

Response

ExamplesSchema

Successful, returns decrypted data.

{
  "data": "string"
}

Was this page helpful?