Protect PDF

Secure a PDF file with a password encrypt the document. Set an owner password and restrictions on certain features like printing, editing and copying in the PDF document to prevent end users from modifying it.

Support for AES-128 and AES-256 encryption on PDF files, with granular permissions for high and low quality printing and fill and sign form field restrictions.

Rest API

See our public API Reference for Protect PDF

Protect PDFs with user password

You can password protect PDFs so that only users with a document open password can open the file.

Please refer the API usage guide to understand how to use our APIs.

Java

.NET

Node JS

Rest API

// Get the samples from https://www.adobe.com/go/pdftoolsapi_java_samples
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.protectpdf.ProtectPDF
 
      public class ProtectPDF {
        // Initialize the logger.
        private static final Logger LOGGER = LoggerFactory.getLogger(ProtectPDF.class);
     
        public static void main(String[] args) {
     
            try {
                // Initial setup, create credentials instance.
                Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
                        .fromFile("pdfservices-api-credentials.json")
                        .build();
     
                // Create an ExecutionContext using credentials.
                ExecutionContext executionContext = ExecutionContext.create(credentials);
     
                // Build ProtectPDF options by setting a User Password and Encryption
                // Algorithm (used for encrypting the PDF file).
                ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.passwordProtectOptionsBuilder()
                        .setUserPassword("encryptPassword")
                        .setEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
                        .build();
     
                // Create a new operation instance.
                ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.createNew(protectPDFOptions);
     
                // Set operation input from a source file.
                FileRef source = FileRef.createFromLocalFile("src/main/resources/protectPDFInput.pdf");
                protectPDFOperation.setInput(source);
     
                // Execute the operation
                FileRef result = protectPDFOperation.execute(executionContext);
     
                // Save the result at the specified location
                result.saveAs("output/protectPDFOutput.pdf");
     
            } catch (ServiceApiException | IOException | SdkException | ServiceUsageException ex) {
                LOGGER.error("Exception encountered while executing operation", ex);
            }
        }
      }
Copied to your clipboard
1// Get the samples from https://www.adobe.com/go/pdftoolsapi_java_samples
2// Run the sample:
3// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.protectpdf.ProtectPDF
4 
5      public class ProtectPDF {
6        // Initialize the logger.
7        private static final Logger LOGGER = LoggerFactory.getLogger(ProtectPDF.class);
8     
9        public static void main(String[] args) {
10     
11            try {
12                // Initial setup, create credentials instance.
13                Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
14                        .fromFile("pdfservices-api-credentials.json")
15                        .build();
16     
17                // Create an ExecutionContext using credentials.
18                ExecutionContext executionContext = ExecutionContext.create(credentials);
19     
20                // Build ProtectPDF options by setting a User Password and Encryption
21                // Algorithm (used for encrypting the PDF file).
22                ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.passwordProtectOptionsBuilder()
23                        .setUserPassword("encryptPassword")
24                        .setEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
25                        .build();
26     
27                // Create a new operation instance.
28                ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.createNew(protectPDFOptions);
29     
30                // Set operation input from a source file.
31                FileRef source = FileRef.createFromLocalFile("src/main/resources/protectPDFInput.pdf");
32                protectPDFOperation.setInput(source);
33     
34                // Execute the operation
35                FileRef result = protectPDFOperation.execute(executionContext);
36     
37                // Save the result at the specified location
38                result.saveAs("output/protectPDFOutput.pdf");
39     
40            } catch (ServiceApiException | IOException | SdkException | ServiceUsageException ex) {
41                LOGGER.error("Exception encountered while executing operation", ex);
42            }
43        }
44      }

// Get the samples from https://www.adobe.com/go/pdftoolsapi_net_samples
// Run the sample:
// cd ProtectPDF/
// dotnet run ProtectPDF.csproj

  namespace ProtectPDF
  {
    class Program
    {
        private static readonly ILog log = LogManager.GetLogger(typeof(Program));
        static void Main()
        {
            //Configure the logging
            ConfigureLogging();
            try
            {
                // Initial setup, create credentials instance.
                Credentials credentials = Credentials.ServiceAccountCredentialsBuilder()
                                .FromFile(Directory.GetCurrentDirectory() + "/pdfservices-api-credentials.json")
                                .Build();
 
                // Create an ExecutionContext using credentials.
                ExecutionContext executionContext = ExecutionContext.Create(credentials);
 
                // Build ProtectPDF options by setting a User Password and Encryption
                // Algorithm (used for encrypting the PDF file).
                ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.PasswordProtectOptionsBuilder()
                        .SetUserPassword("encryptPassword")
                        .SetEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
                        .Build();
 
                // Create a new operation instance
                ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.CreateNew(protectPDFOptions);
 
                // Set operation input from a source file.
                FileRef sourceFileRef = FileRef.CreateFromLocalFile(@"protectPDFInput.pdf");
                protectPDFOperation.SetInput(sourceFileRef);
 
                // Execute the operation.
                FileRef result = protectPDFOperation.Execute(executionContext);
 
                // Save the result to the specified location.
                result.SaveAs(Directory.GetCurrentDirectory() + "/output/protectPDFOutput.pdf");
            }
            catch (ServiceUsageException ex)
            {
                log.Error("Exception encountered while executing operation", ex);
            }
            // Catch more errors here . . .
        }
 
        static void ConfigureLogging()
        {
            ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
            XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
        }
    }
  }
Copied to your clipboard
1// Get the samples from https://www.adobe.com/go/pdftoolsapi_net_samples
2// Run the sample:
3// cd ProtectPDF/
4// dotnet run ProtectPDF.csproj
5
6  namespace ProtectPDF
7  {
8    class Program
9    {
10        private static readonly ILog log = LogManager.GetLogger(typeof(Program));
11        static void Main()
12        {
13            //Configure the logging
14            ConfigureLogging();
15            try
16            {
17                // Initial setup, create credentials instance.
18                Credentials credentials = Credentials.ServiceAccountCredentialsBuilder()
19                                .FromFile(Directory.GetCurrentDirectory() + "/pdfservices-api-credentials.json")
20                                .Build();
21 
22                // Create an ExecutionContext using credentials.
23                ExecutionContext executionContext = ExecutionContext.Create(credentials);
24 
25                // Build ProtectPDF options by setting a User Password and Encryption
26                // Algorithm (used for encrypting the PDF file).
27                ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.PasswordProtectOptionsBuilder()
28                        .SetUserPassword("encryptPassword")
29                        .SetEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
30                        .Build();
31 
32                // Create a new operation instance
33                ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.CreateNew(protectPDFOptions);
34 
35                // Set operation input from a source file.
36                FileRef sourceFileRef = FileRef.CreateFromLocalFile(@"protectPDFInput.pdf");
37                protectPDFOperation.SetInput(sourceFileRef);
38 
39                // Execute the operation.
40                FileRef result = protectPDFOperation.Execute(executionContext);
41 
42                // Save the result to the specified location.
43                result.SaveAs(Directory.GetCurrentDirectory() + "/output/protectPDFOutput.pdf");
44            }
45            catch (ServiceUsageException ex)
46            {
47                log.Error("Exception encountered while executing operation", ex);
48            }
49            // Catch more errors here . . .
50        }
51 
52        static void ConfigureLogging()
53        {
54            ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
55            XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
56        }
57    }
58  }

// Get the samples from http://www.adobe.com/go/pdftoolsapi_node_sample
// Run the sample:
// node src/protectpdf/protect-pdf.js

    const PDFServicesSdk = require('@adobe/pdfservices-node-sdk');
   
    try {
      // Initial setup, create credentials instance.
      const credentials =  PDFServicesSdk.Credentials
          .serviceAccountCredentialsBuilder()
          .fromFile("pdfservices-api-credentials.json")
          .build();
   
      // Create an ExecutionContext using credentials
      const executionContext = PDFServicesSdk.ExecutionContext.create(credentials);
   
      // Build ProtectPDF options by setting a User Password and Encryption
      // Algorithm (used for encrypting the PDF file).
      const protectPDF = PDFServicesSdk.ProtectPDF,
          options = new protectPDF.options.PasswordProtectOptions.Builder()
              .setUserPassword("encryptPassword")
              .setEncryptionAlgorithm(PDFServicesSdk.ProtectPDF.options.EncryptionAlgorithm.AES_256)
              .build();
   
      // Create a new operation instance.
      const protectPDFOperation = protectPDF.Operation.createNew(options);
   
      // Set operation input from a source file.
      const input = PDFServicesSdk.FileRef.createFromLocalFile('resources/protectPDFInput.pdf');
      protectPDFOperation.setInput(input);
   
      // Execute the operation and Save the result to the specified location.
      protectPDFOperation.execute(executionContext)
          .then(result => result.saveAsFile('output/protectPDFOutput.pdf'))
          .catch(err => {
              if(err instanceof PDFServicesSdk.Error.ServiceApiError
                  || err instanceof PDFServicesSdk.Error.ServiceUsageError) {
                  console.log('Exception encountered while executing operation', err);
              } else {
                  console.log('Exception encountered while executing operation', err);
              }
          });
    } catch (err) {
      console.log('Exception encountered while executing operation', err);
    }
Copied to your clipboard
1// Get the samples from http://www.adobe.com/go/pdftoolsapi_node_sample
2// Run the sample:
3// node src/protectpdf/protect-pdf.js
4
5    const PDFServicesSdk = require('@adobe/pdfservices-node-sdk');
6   
7    try {
8      // Initial setup, create credentials instance.
9      const credentials =  PDFServicesSdk.Credentials
10          .serviceAccountCredentialsBuilder()
11          .fromFile("pdfservices-api-credentials.json")
12          .build();
13   
14      // Create an ExecutionContext using credentials
15      const executionContext = PDFServicesSdk.ExecutionContext.create(credentials);
16   
17      // Build ProtectPDF options by setting a User Password and Encryption
18      // Algorithm (used for encrypting the PDF file).
19      const protectPDF = PDFServicesSdk.ProtectPDF,
20          options = new protectPDF.options.PasswordProtectOptions.Builder()
21              .setUserPassword("encryptPassword")
22              .setEncryptionAlgorithm(PDFServicesSdk.ProtectPDF.options.EncryptionAlgorithm.AES_256)
23              .build();
24   
25      // Create a new operation instance.
26      const protectPDFOperation = protectPDF.Operation.createNew(options);
27   
28      // Set operation input from a source file.
29      const input = PDFServicesSdk.FileRef.createFromLocalFile('resources/protectPDFInput.pdf');
30      protectPDFOperation.setInput(input);
31   
32      // Execute the operation and Save the result to the specified location.
33      protectPDFOperation.execute(executionContext)
34          .then(result => result.saveAsFile('output/protectPDFOutput.pdf'))
35          .catch(err => {
36              if(err instanceof PDFServicesSdk.Error.ServiceApiError
37                  || err instanceof PDFServicesSdk.Error.ServiceUsageError) {
38                  console.log('Exception encountered while executing operation', err);
39              } else {
40                  console.log('Exception encountered while executing operation', err);
41              }
42          });
43    } catch (err) {
44      console.log('Exception encountered while executing operation', err);
45    }

// Please refer our Rest API docs for more information 
// https://developer.adobe.com/document-services/docs/apis/#tag/Protect-PDF

curl --location --request POST 'https://pdf-services.adobe.io/operation/protectpdf' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--data-raw '{
    "passwordProtection": {
        "userPassword": "user_password"
    },
    "encryptionAlgorithm": "AES_128",
    "assetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718"
}'

// Legacy API can be found here 
// https://documentcloud.adobe.com/document-services/index.html#post-protectPDF
Copied to your clipboard
1// Please refer our Rest API docs for more information 
2// https://developer.adobe.com/document-services/docs/apis/#tag/Protect-PDF
3
4curl --location --request POST 'https://pdf-services.adobe.io/operation/protectpdf' \
5--header 'x-api-key: {{Placeholder for client_id}}' \
6--header 'Content-Type: application/json' \
7--header 'Authorization: Bearer {{Placeholder for token}}' \
8--data-raw '{
9    "passwordProtection": {
10        "userPassword": "user_password"
11    },
12    "encryptionAlgorithm": "AES_128",
13    "assetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718"
14}'
15
16// Legacy API can be found here 
17// https://documentcloud.adobe.com/document-services/index.html#post-protectPDF

Protect PDFs with owner password

You can secure a PDF file with owner/permissions password and set the restriction on certain features like printing, editing and copying in the PDF document. Refer to ContentEncryption and Permission in the API docs for a list of supported types of content to encrypt and types of document permissions.

Please refer the API usage guide to understand how to use our APIs.

Java

.NET

Node JS

Rest API

// Get the samples from https://www.adobe.com/go/pdftoolsapi_java_samples
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.protectpdf.ProtectPDFWithOwnerPassword
 
 public class ProtectPDFWithOwnerPassword {

   // Initialize the logger.
   private static final Logger LOGGER = LoggerFactory.getLogger(ProtectPDFWithOwnerPassword.class);

   public static void main(String[] args) {

       try {
           // Initial setup, create credentials instance.
           Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
                   .fromFile("pdfservices-api-credentials.json")
                   .build();

           // Create an ExecutionContext using credentials.
           ExecutionContext executionContext = ExecutionContext.create(credentials);

           // Create new permissions instance and add the required permissions
           Permissions permissions = Permissions.createNew();
           permissions.addPermission(Permission.PRINT_LOW_QUALITY);
           permissions.addPermission(Permission.EDIT_DOCUMENT_ASSEMBLY);
           permissions.addPermission(Permission.COPY_CONTENT);

           // Build ProtectPDF options by setting an Owner/Permissions Password, Permissions,
           // Encryption Algorithm (used for encrypting the PDF file) and specifying the type of content to encrypt.
           ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.passwordProtectOptionsBuilder()
                   .setOwnerPassword("password")
                   .setPermissions(permissions)
                   .setEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
                   .setContentEncryption(ContentEncryption.ALL_CONTENT_EXCEPT_METADATA)
                   .build();

           // Create a new operation instance.
           ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.createNew(protectPDFOptions);

           // Set operation input from a source file.
           FileRef source = FileRef.createFromLocalFile("src/main/resources/protectPDFInput.pdf");
           protectPDFOperation.setInput(source);

           // Execute the operation
           FileRef result = protectPDFOperation.execute(executionContext);

           // Save the result at the specified location
           result.saveAs("output/protectPDFWithOwnerPasswordOutput.pdf");

       } catch (ServiceApiException | IOException | SdkException | ServiceUsageException ex) {
           LOGGER.error("Exception encountered while executing operation", ex);
       }
   }
 }
     
Copied to your clipboard
1// Get the samples from https://www.adobe.com/go/pdftoolsapi_java_samples
2// Run the sample:
3// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.protectpdf.ProtectPDFWithOwnerPassword
4 
5 public class ProtectPDFWithOwnerPassword {
6
7   // Initialize the logger.
8   private static final Logger LOGGER = LoggerFactory.getLogger(ProtectPDFWithOwnerPassword.class);
9
10   public static void main(String[] args) {
11
12       try {
13           // Initial setup, create credentials instance.
14           Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
15                   .fromFile("pdfservices-api-credentials.json")
16                   .build();
17
18           // Create an ExecutionContext using credentials.
19           ExecutionContext executionContext = ExecutionContext.create(credentials);
20
21           // Create new permissions instance and add the required permissions
22           Permissions permissions = Permissions.createNew();
23           permissions.addPermission(Permission.PRINT_LOW_QUALITY);
24           permissions.addPermission(Permission.EDIT_DOCUMENT_ASSEMBLY);
25           permissions.addPermission(Permission.COPY_CONTENT);
26
27           // Build ProtectPDF options by setting an Owner/Permissions Password, Permissions,
28           // Encryption Algorithm (used for encrypting the PDF file) and specifying the type of content to encrypt.
29           ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.passwordProtectOptionsBuilder()
30                   .setOwnerPassword("password")
31                   .setPermissions(permissions)
32                   .setEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
33                   .setContentEncryption(ContentEncryption.ALL_CONTENT_EXCEPT_METADATA)
34                   .build();
35
36           // Create a new operation instance.
37           ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.createNew(protectPDFOptions);
38
39           // Set operation input from a source file.
40           FileRef source = FileRef.createFromLocalFile("src/main/resources/protectPDFInput.pdf");
41           protectPDFOperation.setInput(source);
42
43           // Execute the operation
44           FileRef result = protectPDFOperation.execute(executionContext);
45
46           // Save the result at the specified location
47           result.saveAs("output/protectPDFWithOwnerPasswordOutput.pdf");
48
49       } catch (ServiceApiException | IOException | SdkException | ServiceUsageException ex) {
50           LOGGER.error("Exception encountered while executing operation", ex);
51       }
52   }
53 }
54

// Get the samples from https://www.adobe.com/go/pdftoolsapi_net_samples
// Run the sample:
// cd ProtectPDFWithOwnerPassword/
// dotnet run ProtectPDFWithOwnerPassword.csproj

 namespace ProtectPDFWithOwnerPassword
 {
   class Program
   {
       private static readonly ILog log = LogManager.GetLogger(typeof(Program));
       static void Main()
       {
           //Configure the logging
           ConfigureLogging();
           try
           {
               // Initial setup, create credentials instance.
               Credentials credentials = Credentials.ServiceAccountCredentialsBuilder()
                               .FromFile(Directory.GetCurrentDirectory() + "/pdfservices-api-credentials.json")
                               .Build();

               // Create an ExecutionContext using credentials.
               ExecutionContext executionContext = ExecutionContext.Create(credentials);

               // Create new permissions instance and add the required permissions
               Permissions permissions = Permissions.CreateNew();
               permissions.AddPermission(Permission.PRINT_LOW_QUALITY);
               permissions.AddPermission(Permission.EDIT_DOCUMENT_ASSEMBLY);
               permissions.AddPermission(Permission.COPY_CONTENT);

               // Build ProtectPDF options by setting an Owner/Permissions Password, Permissions,
               // Encryption Algorithm (used for encrypting the PDF file) and specifying the type of content to encrypt.
               ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.PasswordProtectOptionsBuilder()
                   .SetOwnerPassword("password")
                   .SetPermissions(permissions)
                   .SetEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
                   .SetContentEncryption(ContentEncryption.ALL_CONTENT_EXCEPT_METADATA)
                   .Build();

               // Create a new operation instance
               ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.CreateNew(protectPDFOptions);

               // Set operation input from a source file.
               FileRef sourceFileRef = FileRef.CreateFromLocalFile(@"protectPDFInput.pdf");
               protectPDFOperation.SetInput(sourceFileRef);

               // Execute the operation.
               FileRef result = protectPDFOperation.Execute(executionContext);

               // Save the result to the specified location.
               result.SaveAs(Directory.GetCurrentDirectory() + "/output/protectPDFWithOwnerPasswordOutput.pdf");
           }
           catch (ServiceUsageException ex)
           {
               log.Error("Exception encountered while executing operation", ex);
           }
           // Catch more errors here . . .
       }

       static void ConfigureLogging()
       {
           ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
           XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
       }
   }
 }
   
Copied to your clipboard
1// Get the samples from https://www.adobe.com/go/pdftoolsapi_net_samples
2// Run the sample:
3// cd ProtectPDFWithOwnerPassword/
4// dotnet run ProtectPDFWithOwnerPassword.csproj
5
6 namespace ProtectPDFWithOwnerPassword
7 {
8   class Program
9   {
10       private static readonly ILog log = LogManager.GetLogger(typeof(Program));
11       static void Main()
12       {
13           //Configure the logging
14           ConfigureLogging();
15           try
16           {
17               // Initial setup, create credentials instance.
18               Credentials credentials = Credentials.ServiceAccountCredentialsBuilder()
19                               .FromFile(Directory.GetCurrentDirectory() + "/pdfservices-api-credentials.json")
20                               .Build();
21
22               // Create an ExecutionContext using credentials.
23               ExecutionContext executionContext = ExecutionContext.Create(credentials);
24
25               // Create new permissions instance and add the required permissions
26               Permissions permissions = Permissions.CreateNew();
27               permissions.AddPermission(Permission.PRINT_LOW_QUALITY);
28               permissions.AddPermission(Permission.EDIT_DOCUMENT_ASSEMBLY);
29               permissions.AddPermission(Permission.COPY_CONTENT);
30
31               // Build ProtectPDF options by setting an Owner/Permissions Password, Permissions,
32               // Encryption Algorithm (used for encrypting the PDF file) and specifying the type of content to encrypt.
33               ProtectPDFOptions protectPDFOptions = ProtectPDFOptions.PasswordProtectOptionsBuilder()
34                   .SetOwnerPassword("password")
35                   .SetPermissions(permissions)
36                   .SetEncryptionAlgorithm(EncryptionAlgorithm.AES_256)
37                   .SetContentEncryption(ContentEncryption.ALL_CONTENT_EXCEPT_METADATA)
38                   .Build();
39
40               // Create a new operation instance
41               ProtectPDFOperation protectPDFOperation = ProtectPDFOperation.CreateNew(protectPDFOptions);
42
43               // Set operation input from a source file.
44               FileRef sourceFileRef = FileRef.CreateFromLocalFile(@"protectPDFInput.pdf");
45               protectPDFOperation.SetInput(sourceFileRef);
46
47               // Execute the operation.
48               FileRef result = protectPDFOperation.Execute(executionContext);
49
50               // Save the result to the specified location.
51               result.SaveAs(Directory.GetCurrentDirectory() + "/output/protectPDFWithOwnerPasswordOutput.pdf");
52           }
53           catch (ServiceUsageException ex)
54           {
55               log.Error("Exception encountered while executing operation", ex);
56           }
57           // Catch more errors here . . .
58       }
59
60       static void ConfigureLogging()
61       {
62           ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
63           XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
64       }
65   }
66 }
67

// Get the samples from http://www.adobe.com/go/pdftoolsapi_node_sample
// Run the sample:
// node src/protectpdf/protect-pdf-with-owner-password.js

  const PDFServicesSdk = require('@adobe/pdfservices-node-sdk');
 
  try {
    // Initial setup, create credentials instance.
    const credentials =  PDFServicesSdk.Credentials
        .serviceAccountCredentialsBuilder()
        .fromFile("pdfservices-api-credentials.json")
        .build();
 
    // Create an ExecutionContext using credentials
    const executionContext = PDFServicesSdk.ExecutionContext.create(credentials);
 
    // Create new permissions instance and add the required permissions
    const protectPDF = PDFServicesSdk.ProtectPDF,
        protectPDFOptions = protectPDF.options,
        permissions = protectPDFOptions.Permissions.createNew();
    permissions.addPermission(protectPDFOptions.Permission.PRINT_LOW_QUALITY);
    permissions.addPermission(protectPDFOptions.Permission.EDIT_DOCUMENT_ASSEMBLY);
    permissions.addPermission(protectPDFOptions.Permission.COPY_CONTENT);
 
    // Build ProtectPDF options by setting an Owner/Permissions Password, Permissions,
    // Encryption Algorithm (used for encrypting the PDF file) and specifying the type of content to encrypt.
    const options = new protectPDFOptions.PasswordProtectOptions.Builder()
            .setOwnerPassword("password")
            .setPermissions(permissions)
            .setEncryptionAlgorithm(protectPDFOptions.EncryptionAlgorithm.AES_256)
            .setContentEncryption(protectPDFOptions.ContentEncryption.ALL_CONTENT_EXCEPT_METADATA)
            .build();
 
    // Create a new operation instance.
    const protectPDFOperation = protectPDF.Operation.createNew(options);
 
    // Set operation input from a source file.
    const input = PDFServicesSdk.FileRef.createFromLocalFile('resources/protectPDFInput.pdf');
    protectPDFOperation.setInput(input);
 
    // Execute the operation and Save the result to the specified location.
    protectPDFOperation.execute(executionContext)
        .then(result => result.saveAsFile('output/protectPDFWithOwnerPasswordOutput.pdf'))
        .catch(err => {
            if(err instanceof PDFServicesSdk.Error.ServiceApiError
                || err instanceof PDFServicesSdk.Error.ServiceUsageError) {
                console.log('Exception encountered while executing operation', err);
            } else {
                console.log('Exception encountered while executing operation', err);
            }
        });
  } catch (err) {
    console.log('Exception encountered while executing operation', err);
  }
Copied to your clipboard
1// Get the samples from http://www.adobe.com/go/pdftoolsapi_node_sample
2// Run the sample:
3// node src/protectpdf/protect-pdf-with-owner-password.js
4
5  const PDFServicesSdk = require('@adobe/pdfservices-node-sdk');
6 
7  try {
8    // Initial setup, create credentials instance.
9    const credentials =  PDFServicesSdk.Credentials
10        .serviceAccountCredentialsBuilder()
11        .fromFile("pdfservices-api-credentials.json")
12        .build();
13 
14    // Create an ExecutionContext using credentials
15    const executionContext = PDFServicesSdk.ExecutionContext.create(credentials);
16 
17    // Create new permissions instance and add the required permissions
18    const protectPDF = PDFServicesSdk.ProtectPDF,
19        protectPDFOptions = protectPDF.options,
20        permissions = protectPDFOptions.Permissions.createNew();
21    permissions.addPermission(protectPDFOptions.Permission.PRINT_LOW_QUALITY);
22    permissions.addPermission(protectPDFOptions.Permission.EDIT_DOCUMENT_ASSEMBLY);
23    permissions.addPermission(protectPDFOptions.Permission.COPY_CONTENT);
24 
25    // Build ProtectPDF options by setting an Owner/Permissions Password, Permissions,
26    // Encryption Algorithm (used for encrypting the PDF file) and specifying the type of content to encrypt.
27    const options = new protectPDFOptions.PasswordProtectOptions.Builder()
28            .setOwnerPassword("password")
29            .setPermissions(permissions)
30            .setEncryptionAlgorithm(protectPDFOptions.EncryptionAlgorithm.AES_256)
31            .setContentEncryption(protectPDFOptions.ContentEncryption.ALL_CONTENT_EXCEPT_METADATA)
32            .build();
33 
34    // Create a new operation instance.
35    const protectPDFOperation = protectPDF.Operation.createNew(options);
36 
37    // Set operation input from a source file.
38    const input = PDFServicesSdk.FileRef.createFromLocalFile('resources/protectPDFInput.pdf');
39    protectPDFOperation.setInput(input);
40 
41    // Execute the operation and Save the result to the specified location.
42    protectPDFOperation.execute(executionContext)
43        .then(result => result.saveAsFile('output/protectPDFWithOwnerPasswordOutput.pdf'))
44        .catch(err => {
45            if(err instanceof PDFServicesSdk.Error.ServiceApiError
46                || err instanceof PDFServicesSdk.Error.ServiceUsageError) {
47                console.log('Exception encountered while executing operation', err);
48            } else {
49                console.log('Exception encountered while executing operation', err);
50            }
51        });
52  } catch (err) {
53    console.log('Exception encountered while executing operation', err);
54  }

// Please refer our Rest API docs for more information 
// https://developer.adobe.com/document-services/docs/apis/#tag/Protect-PDF

curl --location --request POST 'https://pdf-services.adobe.io/operation/protectpdf' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--data-raw '{
  "passwordProtection": {
    "ownerPassword": "owner_password"
  },
  "encryptionAlgorithm": "AES_256",
  "assetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718"
}'

// Legacy API can be found here 
// https://documentcloud.adobe.com/document-services/index.html#post-protectPDF
Copied to your clipboard
1// Please refer our Rest API docs for more information 
2// https://developer.adobe.com/document-services/docs/apis/#tag/Protect-PDF
3
4curl --location --request POST 'https://pdf-services.adobe.io/operation/protectpdf' \
5--header 'x-api-key: {{Placeholder for client_id}}' \
6--header 'Content-Type: application/json' \
7--header 'Authorization: Bearer {{Placeholder for token}}' \
8--data-raw '{
9  "passwordProtection": {
10    "ownerPassword": "owner_password"
11  },
12  "encryptionAlgorithm": "AES_256",
13  "assetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718"
14}'
15
16// Legacy API can be found here 
17// https://documentcloud.adobe.com/document-services/index.html#post-protectPDF

Linearize PDF

Remove Protection

Last updated 7/19/2023

Was this helpful?

Yes

Protect PDF

Rest API.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Protect PDFs with user password

Protect PDFs with owner password

Rest API