@piiano/vault-client/dist/generated/models/EncryptionRequest.d.ts

Piiano Vault generated typescript client

import type { EncryptionType } from './EncryptionType';
import type { InputObject } from './InputObject';
import type { PropertyName } from './PropertyName';
import type { Tag } from './Tag';
export type EncryptionRequest = {
    type?: EncryptionType;
    object: InputObject;
    /**
     * A list of the properties to include in the encrypted object.
     * If not provided, all properties are included, including the built-in properties, but omitting the object ID.
     *
     */
    props?: Array<PropertyName>;
    /**
     * A classification for the encrypted object that is added to the ciphertext as associated data (AAD).
     * An object encrypted with a scope can be decrypted only with the same scope.
     *
     */
    scope?: string;
    /**
     * Tags to attach to the metadata of the encrypted object.
     * The maximum number of allowed tags is defined by the [`PVAULT_DB_MAX_TOKEN_TAGS` environment variable](/guides/configure/environment-variables#database) (default 10).
     * Tags are not supported for the `deterministic` encryption type.
     *
     */
    tags?: Array<Tag>;
};
//# sourceMappingURL=EncryptionRequest.d.ts.map