# EncryptOptions

## Content

[**DsPdfJS API v9.1.3**](../README)

***

[DsPdfJS API](../globals) / EncryptOptions

# Type Alias: EncryptOptions

> **EncryptOptions** = `object`

Defines the options for the [Security#setEncryptOptions](../classes/Security#setencryptoptions) method.

## Properties

### encryptionLevel?

> `optional` **encryptionLevel**: [`EncryptionLevel`](../enumerations/EncryptionLevel)

Gets or sets encryption level.
The default value: EncryptionLevel.AES256.

***

### encryptMetadata?

> `optional` **encryptMetadata**: `boolean`

Gets or sets a value indicating whether the document-level metadata stream
is to be encrypted.
The default value: true.

***

### permissions?

> `optional` **permissions**: [`PermissionOptions`](PermissionOptions)

Gets or sets a [PermissionOptions](PermissionOptions) object defining the document permissions.

***

### userPassword

> **userPassword**: `string`

Gets or sets the password required to open a PDF document.