Skip to main content
PUT
Update an encryption material

Authorizations

Authorization
string
header
required

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

Path Parameters

encryption_material_id
string
required

Unique identifier for an encryption material The id of the encryption material. Six characters of URL-safe base64.

Example:

"YGA7xw"

Body

application/json

Replaces the encryption material's name, description and collaborators. Omitting description clears it, and omitting collaborators stops sharing the material with anyone. Omitting tags leaves the tags as they are.

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

Which other companies can use the encryption material.

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

Replaces the tags. Must not be empty when present.

Minimum array length: 1
Minimum string length: 1

Response

OK

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"