How to Encrypt/Add Password & Permissions to PDF Files in C#

Curtis Chau

Updated: August 2, 2026

Download IronSecureDoc

• DockerHub Download

• ---

• Start Free Trial

Copy for LLMs

• Copy for LLMs

  Copy page as Markdown for LLMs
  # How to Encrypt/Add Password & Permissions to PDF Files in C&num; Securing PDF files with passwords and specific permissions is vital for protecting sensitive documents from unauthorized access and manipulation. The [POST] Encrypt/Add Password & Permissions API from IronSecure Doc provides an efficient way to encrypt PDF files with user and owner passwords while configuring permissions for printing, form filling, annotations, and more. This API ensures that the PDF is fully protected and access is controlled, making it ideal for legal, financial, or personal documents. <div class="hsg-featured-snippet"> <h2>How to Encrypt/Add Password & Permissions to PDF Files</h2> <ol> <li><a class="js-modal-open" data-modal-id="trial-license-after-download" href="https://hub.docker.com/r/ironsoftwareofficial/ironsecuredoc">Pull and start the IronSecureDoc Docker Image</a></li> <li>Test the API using Swagger</li> <li>Specify the parameters for password and permissions</li> <li>Execute the API call to apply the changes</li> <li>Export the encrypted PDF document</li> </ol> </div> ## Pull and Start IronSecureDoc If you don't have IronSecureDoc running yet, please follow the links below to get it set up: <table class="table"> <tr> <th style="text-align: center;">Host Locally</th> <th style="text-align: center;">Deploy to Cloud</th> </tr> <tr> <td style="vertical-align: top;"> <ul> <li><a href="/enterprise/securedoc/tutorials/hosting-windows/">Hosting on Windows</a></li> <li><a href="/enterprise/securedoc/tutorials/hosting-mac/">Hosting on Mac</a></li> <li><a href="/enterprise/securedoc/tutorials/hosting-linux/">Hosting on Linux</a></li> </ul> </td> <td style="vertical-align: top;"> <ul> <li><a href="/enterprise/securedoc/tutorials/set-up-azure/">Deploy on Azure Container</a></li> <li><a href="/enterprise/securedoc/tutorials/set-up-aws/">Deploy on AWS Container</a></li> </ul> </td> </tr> </table> ## The [POST] Encrypt/Add Password & Permissions API The [POST] Encrypt/Add Password & Permissions API allows you to add security layers to PDF documents by encrypting them with passwords and setting specific permissions for various operations. Whether it's granting read access, allowing form filling, or disabling printing, this API gives you control over how your PDF files are accessed and modified. ## Swagger Swagger offers a user-friendly interface to test this API interactively. You can use it to send test requests and receive responses without writing code, making it a great tool for developers. ### Steps to Redact Text with Swagger 1. **Access the Swagger UI:** If your API server is running locally, you can access Swagger by navigating to `http://localhost:8080/swagger/index.html` in your web browser.  2. **Locate the API:** Find the [POST] `/v1/document-services/pdfs/encrypt` API, which corresponds to Encrypt/Add Password & Permissions.  3. **Input Parameters:** Provide the required parameters for the API. You can upload a sample PDF file and specify the desired permissions. 4. **Upload PDF File:** In the request body, upload a PDF file as `pdf_file` and define the necessary permissions, such as allowing or restricting printing, form filling, and content extraction. 5. **Execute the Request:** Once all parameters are set, click "Execute" to send the request. The response will return the encrypted PDF with the specified security settings. 6. **Check the Output PDF:** Type in 'password' to view the PDF content. <iframe src="/static-assets/securedoc/how-to/password-and-permission/output.pdf" width="100%" height="400px"> This browser does not support PDFs. Please download the PDF to view it: <a href="/static-assets/securedoc/how-to/password-and-permission/output.pdf">Download PDF</a>. </iframe> <hr /> ## Understanding Input Parameters The API requires specific parameters to encrypt the PDF and assign permissions. Below is a breakdown of both required and optional parameters: **Required Parameters** <table class="table"> <tr> <th style="text-align: center;">Name</th> <th style="text-align: center;">Data Type</th> <th style="text-align: center;">Description</th> </tr> <tr> <td><code>pdf_file</code></td> <td>application/pdf</td> <td>The PDF file you want to encrypt.</td> </tr> <tr> <td><code>allow_extracting_content</code></td> <td>boolean</td> <td>Indicate whether content extraction is allowed.</td> </tr> <tr> <td><code>allow_form_filling</code></td> <td>boolean</td> <td>Indicate whether form filling is allowed.</td> </tr> <tr> <td><code>allow_annotations</code></td> <td>boolean</td> <td>Indicate whether annotations are allowed.</td> </tr> <tr> <td><code>allow_printing</code></td> <td>boolean</td> <td>Indicate whether printing is allowed.</td> </tr> <tr> <td><code>allow_modifications</code></td> <td>boolean</td> <td>Indicate whether modifications are allowed.</td> </tr> <tr> <td><code>new_owner_password</code></td> <td>string</td> <td>The new owner password for the PDF, which grants full access and the ability to change permissions.</td> </tr> </table> **Optional Parameters** <table class="table"> <tr> <th style="text-align: center;">Name</th> <th style="text-align: center;">Data Type</th> <th style="text-align: center;">Description</th> </tr> <tr> <td><code>user_password</code></td> <td>string</td> <td>The current user password, required if the PDF has a user password to grant read access.</td> </tr> <tr> <td><code>owner_password</code></td> <td>string</td> <td>The current owner password, required if the PDF has an owner password to grant full access.</td> </tr> <tr> <td><code>new_user_password</code></td> <td>string</td> <td>The new user password for read access.</td> </tr> <tr> <td><code>save_as_pdfa</code></td> <td>boolean</td> <td>Save the PDF as PDF/A-3 compliant.</td> </tr> <tr> <td><code>save_as_pdfua</code></td> <td>boolean</td> <td>Save the PDF as PDF/UA compliant.</td> </tr> <tr> <td><code>author</code></td> <td>string</td> <td>Set the PDF metadata Author property.</td> </tr> <tr> <td><code>title</code></td> <td>string</td> <td>Set the PDF metadata Title property.</td> </tr> <tr> <td><code>subject</code></td> <td>string</td> <td>Set the PDF metadata Subject property.</td> </tr> </table> <hr /> ## API Integration: Python Example Once you're familiar with the input parameters, you can call the API using Python or any other preferred language. Below is an example of how to integrate this API using Python. ```python import requests # Endpoint URL url = 'http://localhost:8080/v1/document-services/pdfs/encrypt' # Headers with metadata information headers = { 'accept': '*/*', 'author': 'Iron Software', 'title': 'ENCRYPTION DEMO 2024', 'subject': 'DEMO EXAMPLE' } # Files to be sent in the request files = { 'pdf_file': ('sample.pdf', open('sample.pdf', 'rb'), 'application/pdf') } # Parameters for encryption and permissions data = { 'allow_extracting_content': 'true', 'allow_form_filling': 'true', 'allow_annotations': 'false', 'allow_printing': 'false', 'allow_modifications': 'true', 'new_owner_password': 'password', 'new_user_password': 'password', 'save_as_pdfa': 'false', 'save_as_pdfua': 'false' } # Send POST request with parameters response = requests.post(url, headers=headers, files=files, data=data) # Save the encrypted PDF to file system with open('sample_encrypted.pdf', 'wb') as f: f.write(response.content) print('PDF encrypted successfully.') ``` **Steps Explained:** - **Load the PDF:** The PDF file to be encrypted is loaded from the local file system. - **Set Encryption Parameters:** Define permissions like allowing printing, form filling, and content extraction, as well as setting new passwords. - **Call the API:** The [POST] Encrypt/Add Password & Permissions API is called, passing the necessary parameters. - **Save the Result:** The encrypted PDF is saved as a new file. The PDF file is encrypted as shown below. Type in 'password' to view the PDF content. <iframe src="/static-assets/securedoc/how-to/password-and-permission/output.pdf" width="100%" height="400px"> This browser does not support PDFs. Please download the PDF to view it: <a href="/static-assets/securedoc/how-to/password-and-permission/output.pdf">Download PDF</a>. </iframe>

• ---

• Open in ChatGPT

  Ask ChatGPT about this page
• Open in Gemini

  Ask Gemini about this page
• Open in Grok

  Ask Grok about this page
• Open in Perplexity

  Ask Perplexity about this page

Share

• Share on Facebook
• Share on X (Twitter)
• Share on LinkedIn

• ---

• Email article

Securing PDF files with passwords and specific permissions is vital for protecting sensitive documents from unauthorized access and manipulation. The [POST] Encrypt/Add Password & Permissions API from IronSecure Doc provides an efficient way to encrypt PDF files with user and owner passwords while configuring permissions for printing, form filling, annotations, and more. This API ensures that the PDF is fully protected and access is controlled, making it ideal for legal, financial, or personal documents.

Pull and Start IronSecureDoc

If you don't have IronSecureDoc running yet, please follow the links below to get it set up:

The [POST] Encrypt/Add Password & Permissions API

The [POST] Encrypt/Add Password & Permissions API allows you to add security layers to PDF documents by encrypting them with passwords and setting specific permissions for various operations. Whether it's granting read access, allowing form filling, or disabling printing, this API gives you control over how your PDF files are accessed and modified.

Swagger

Swagger offers a user-friendly interface to test this API interactively. You can use it to send test requests and receive responses without writing code, making it a great tool for developers.

Steps to Redact Text with Swagger

1. Access the Swagger UI:

If your API server is running locally, you can access Swagger by navigating to http://localhost:8080/swagger/index.html in your web browser.

2. Locate the API:

Find the [POST] /v1/document-services/pdfs/encrypt API, which corresponds to Encrypt/Add Password & Permissions.

3. Input Parameters:

Provide the required parameters for the API. You can upload a sample PDF file and specify the desired permissions.

4. Upload PDF File:

In the request body, upload a PDF file as pdf_file and define the necessary permissions, such as allowing or restricting printing, form filling, and content extraction.

5. Execute the Request:

Once all parameters are set, click "Execute" to send the request. The response will return the encrypted PDF with the specified security settings.

6. Check the Output PDF:

Type in 'password' to view the PDF content.

Understanding Input Parameters

The API requires specific parameters to encrypt the PDF and assign permissions. Below is a breakdown of both required and optional parameters:

Required Parameters

Optional Parameters

API Integration: Python Example

Once you're familiar with the input parameters, you can call the API using Python or any other preferred language. Below is an example of how to integrate this API using Python.

import requests

# Endpoint URL
url = 'http://localhost:8080/v1/document-services/pdfs/encrypt'

# Headers with metadata information
headers = {
    'accept': '*/*',
    'author': 'Iron Software',
    'title': 'ENCRYPTION DEMO 2024',
    'subject': 'DEMO EXAMPLE'
}

# Files to be sent in the request
files = {
    'pdf_file': ('sample.pdf', open('sample.pdf', 'rb'), 'application/pdf')
}

# Parameters for encryption and permissions
data = {
    'allow_extracting_content': 'true',
    'allow_form_filling': 'true',
    'allow_annotations': 'false',
    'allow_printing': 'false',
    'allow_modifications': 'true',
    'new_owner_password': 'password',
    'new_user_password': 'password',
    'save_as_pdfa': 'false',
    'save_as_pdfua': 'false'
}

# Send POST request with parameters
response = requests.post(url, headers=headers, files=files, data=data)

# Save the encrypted PDF to file system
with open('sample_encrypted.pdf', 'wb') as f:
    f.write(response.content)

print('PDF encrypted successfully.')

import requests

# Endpoint URL
url = 'http://localhost:8080/v1/document-services/pdfs/encrypt'

# Headers with metadata information
headers = {
    'accept': '*/*',
    'author': 'Iron Software',
    'title': 'ENCRYPTION DEMO 2024',
    'subject': 'DEMO EXAMPLE'
}

# Files to be sent in the request
files = {
    'pdf_file': ('sample.pdf', open('sample.pdf', 'rb'), 'application/pdf')
}

# Parameters for encryption and permissions
data = {
    'allow_extracting_content': 'true',
    'allow_form_filling': 'true',
    'allow_annotations': 'false',
    'allow_printing': 'false',
    'allow_modifications': 'true',
    'new_owner_password': 'password',
    'new_user_password': 'password',
    'save_as_pdfa': 'false',
    'save_as_pdfua': 'false'
}

# Send POST request with parameters
response = requests.post(url, headers=headers, files=files, data=data)

# Save the encrypted PDF to file system
with open('sample_encrypted.pdf', 'wb') as f:
    f.write(response.content)

print('PDF encrypted successfully.')

Steps Explained:

• Load the PDF: The PDF file to be encrypted is loaded from the local file system.
• Set Encryption Parameters: Define permissions like allowing printing, form filling, and content extraction, as well as setting new passwords.
• Call the API: The [POST] Encrypt/Add Password & Permissions API is called, passing the necessary parameters.
• Save the Result: The encrypted PDF is saved as a new file.

The PDF file is encrypted as shown below. Type in 'password' to view the PDF content.

Curtis Chau

Chat with engineering team now

Technical Writer

Curtis Chau holds a Bachelor’s degree in Computer Science (Carleton University) and specializes in front-end development with expertise in Node.js, TypeScript, JavaScript, and React. Passionate about crafting intuitive and aesthetically pleasing user interfaces, Curtis enjoys working with modern frameworks and creating well-structured, visually appealing manuals.

...

Read More