Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Encrypt With Crypto Key

POST
/vault/v1/workspaces/{workspace}/engines/qibdo/cryptoKeys/{id}:encrypt
 
curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/cryptoKeys/example:encrypt \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "id": "example", "plaintext": "example", "key_version": "example", "associated_data": "example" }'

AIP-136 custom method. Encrypts plaintext under the key’s latest ENABLED version (or key_version if specified). Returns the ciphertext blob and the version number used.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace the crypto key belongs to.

id
required
string

The unique identifier of the crypto key.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request payload for Encrypt With Qibdo Crypto Key

Carries the input fields required to encrypt with qibdo crypto key.

object
workspace
required

The workspace the crypto key belongs to.

string
id
required

The unique identifier of the crypto key.

string
plaintext
required

The plaintext bytes to encrypt (1 byte – 1 MiB).

string format: bytes
key_version

Optional explicit version number to encrypt under. Defaults to the latest ENABLED version.

string
associated_data

Optional associated data (AAD) for AEAD modes; empty when omitted.

string format: bytes
Example generated
{
  "workspace": "example",
  "id": "example",
  "plaintext": "example",
  "key_version": "example",
  "associated_data": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response payload from Encrypt With Qibdo Crypto Key

Carries the output produced by encrypt with qibdo crypto key.

object
ciphertext

The opaque ciphertext envelope. Carries the version number internally so it can decrypt without external bookkeeping.

string format: bytes
key_version

The version of the crypto key that produced the ciphertext.

string
Example generated
{
  "ciphertext": "example",
  "key_version": "example"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}