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

Generate Data Encryption Key

POST
/vault/v1/workspaces/{workspace}/engines/qibdo/cryptoKeys/{id}:generateDataEncryptionKey
 
curl --request POST \
  --url https://example.com/vault/v1/workspaces/example/engines/qibdo/cryptoKeys/example:generateDataEncryptionKey \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "id": "example", "bits": 1, "wrapped_only": true }'

AIP-136 custom method. Generates a data encryption key (DEK) wrapped under the named key. Optionally returns the plaintext DEK in the same response for envelope encryption flows.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace the wrapping crypto key belongs to.

id
required
string

The unique identifier of the wrapping crypto key.

Request Body required

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

Request payload for Generate Data Encryption Key

Carries the input fields required to generate data encryption key.

object
workspace
required

The workspace the wrapping crypto key belongs to.

string
id
required

The unique identifier of the wrapping crypto key.

string
bits
required

The size of the DEK to generate, in bits. Typical values: 128, 256, 512.

integer format: int32
wrapped_only

When true, the response omits the plaintext DEK (only the wrapped form is returned).

boolean
Example generated
{
  "workspace": "example",
  "id": "example",
  "bits": 1,
  "wrapped_only": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response payload from Generate Data Encryption Key

Carries the output produced by generate data encryption key.

object
plaintext

The DEK in plaintext form. Empty when wrapped_only=true.

string format: bytes
ciphertext

The DEK wrapped (encrypted) under the named crypto key.

string format: bytes
key_version

The version of the wrapping crypto key.

string
Example generated
{
  "plaintext": "example",
  "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"
    }
  ]
}