Skip to main content
POST
Create an encryption material

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
display_name
string
required

The name of the encryption material. Must not be blank, and must be shorter than 1024 characters.

Required string length: 1 - 1023
Example:

"My encryption material"

collaborators
object

Defaults to sharing with no one ({"encode": {"type": "none"}}).

Example:
description
string | null

Must not be blank, and must be shorter than 8192 characters.

Required string length: 1 - 8191
Example:

"Some kind of description"

tags
string[] | null

Defaults to no tags.

Minimum string length: 1

Response

Created

type
enum<string>
required
Available options:
owned
id
string
required

The id of the encryption material. Six characters of URL-safe base64.

Example:

"YGA7xw"

collaborators
object
required

Which other companies can use the encryption material.

Example:
company_id
integer<int64>
required

The id of an existing company

Example:

345

created_at
string<date-time>
required
display_name
string
required

The name of the encryption material. Must not be blank, and must be shorter than 1024 characters.

Required string length: 1 - 1023
Example:

"My encryption material"

tags
string[]
required
Minimum string length: 1
updated_at
string<date-time>
required
updated_by
integer<int64>
required

The id of an existing user

Example:

20

description
string | null

Must not be blank, and must be shorter than 8192 characters.

Required string length: 1 - 8191
Example:

"Some kind of description"