Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 2.48 KB

EncryptionKeyDto.md

File metadata and controls

34 lines (26 loc) · 2.48 KB

EncryptionKeyDto

An encryption key pair as the portal reports it: the public half of some member's key, with the encrypted private half filled in only when the pair belongs to the caller.

Properties

Name Type Description Notes
id UUID Names the pair inside its owner's key set. Pass it back to rotate the pair or to delete it; the all-zero value belongs to a client that stores its keys without sending an identifier. [optional]
user_id UUID The member the pair belongs to. In the key set of a room or of a file this is how the caller tells its own entries, the ones carrying a private half, from those of the other members. [optional]
var_date datetime When this key material was written. Rotating the pair refreshes it, so it dates the material that is being reported rather than the first appearance of the identifier. A pair stored before key sets existed (the one with the all-zero identifier) has no recorded date and reports 0001-01-01T00:00:00 until it is rotated. [optional]
public_key str The public half of the pair, the half a client encrypts file keys with. A pair whose public half is missing is treated as no access and left out of a room's or a file's key set. [optional]
private_key_enc str The private half, encrypted with its owner's password. It is filled in only when the pair belongs to the calling user; on another member's entry it comes back empty, because the private half is not handed out. [optional]
crypto_engine_id str The crypto engine this material was issued for, as a braced GUID. The engine is portal-wide, so the same value comes back for every key of every member. [optional]

Example

from docspace_api_sdk.models.encryption_key_dto import EncryptionKeyDto

# TODO update the JSON string below
json = "{}"
# create an instance of EncryptionKeyDto from a JSON string
encryption_key_dto_instance = EncryptionKeyDto.from_json(json)
# print the JSON string representation of the object
print(EncryptionKeyDto.to_json())

# convert the object into a dict
encryption_key_dto_dict = encryption_key_dto_instance.to_dict()
# create an instance of EncryptionKeyDto from a dict
encryption_key_dto_from_dict = EncryptionKeyDto.from_dict(encryption_key_dto_dict)

[Back to Model list] [Back to API list] [Back to README]