Interface ChangeBlobKeyRequest

Ask the server to change the salt, delete the storage at the old blob key, and add a new encrypted storage entry encrypted with the new blob key.

interface ChangeBlobKeyRequest {
    encryptedBlob: string;
    knownRevision?: string;
    newBlobKey: string;
    newSalt: string;
    oldBlobKey: string;
    pcd?: SerializedPCD<SemaphoreSignaturePCD>;
    uuid: string;
}

Properties

encryptedBlob knownRevision? newBlobKey newSalt oldBlobKey pcd? uuid

Properties

encryptedBlob

encryptedBlob: string

The encrypted and stringified version of EncryptedStorage to save

Optional knownRevision

knownRevision?: string

Optional field allowing the client to detect and avoid conflicting updates.

If specified, this is the previous revision of stored data which the client is aware of and has included in its updates. If this does not match the latest revision available on the server, the request will fail without making any changes.

If this field is absent, the new blob is always saved, overwriting any existing revision.

newBlobKey

newBlobKey: string

The new hashed encryption key to be added.

newSalt

newSalt: string

The salt used in generating the new blob key.

oldBlobKey

oldBlobKey: string

The original hashed encryption key to be deleted.

Optional pcd

pcd?: SerializedPCD<SemaphoreSignaturePCD>

Signature PCD by the user who is changing the blob key. This is used to associate the e2ee storage with the user's identity.

uuid

uuid: string

UUID of the user making the request.

Settings

Member Visibility

Theme

On This Page

encryptedBlobknownRevisionnewBlobKeynewSaltoldBlobKeypcduuid

Generated using TypeDoc