Update policy operation

Updates the properties of an existing policy.

For information about the General and Route Evaluation property groups, see Common operation properties.

Input properties

Properties to specify the principals and offline lease period of a policy.

Policy Set Name

(Optional) A string value that represents the name of the existing policy set that contains the policy to update. If a policy is not specified, the policy is based on the policy of the user who invokes the operation.

If you provide a literal value, type a new name for the policy set.

Policy Name

A string value that contains the name of the policy. This value can have a maximum length of 50 characters.

If you provide a literal value, type the name of the document.

Offline Lease Period

(Optional) A string value that represents the number of days a recipient can access a document without a network connection to the server that runs Rights Management. The default is 30.

If you provide a literal value, type the number of days.

Principals To Add

(Optional) A list of Principal Reference values that represent the principals to add to the policy. If no value is specified, the original principals remain unchanged.

If you provide a literal value, click the plus sign button  to display the Add Users and Groups dialog box to add principals. (See Add users and groups). You can also select a principal from the list and click the minus sign button  to remove it.

Principals To Remove

(Optional) A list of Principal Reference values that represent the principals to remove.

If you provide a literal value, click the plus sign button to display the Add Users and Groups dialog box to add principals. (See Add users and groups). You can also select a principal from the list and click the minus sign button to remove it.

Watermark Name

(Optional) A string value that represents the name of the watermark to add to the PDF document.

If you provide a literal value, type the name of the watermark as configured in Rights Management in the Administration Console. (See Rights Management Administration Help.)

Exceptions

This operation can throw an SDKException exception.