Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Permission preservation policy determines how you want permissions to be applied with your job execution(s). There are 3 options available:

...

Setting

API Parameter

Description

Disable Preserve item Permissions

"policy": "none"

No permissions will be passed from source to destination. This is the default.

Add Permissions

"policy": "add"

The current permissions existing on impending transfers (on files or folders) will be preserved as they are transferred on both the source and the destination. This is the recommended setting.

Prefer the permissions on Source

"policy": "diff"

This will reconcile permissions with the source, which will remove permissions from the destination if they do not match the source. This will keep things in sync if the destination folder levels more permissions than the source. This is a good option for sync jobs that are constantly moving back and forth to keep everything as intended.

Assign Permissions from file

"policy": "add"

The location of the import file must be specified in the import path. See the sample JSON at the bottom of the page.

Permissions will be assigned based on the permissions import.

Shared links only

"policy": "none"

AND

"links": true,

This preserves permissions for shared links only.

Failure Policy

Permission failure policy determines what should happen with your job execution(s) should it encounter failures. There are 4 options available:

...

UI Setting

API Parameter

Description

Transfer the item

"failures": "none"

Do not halt transfer of the item on permission failures. This is the recommended settingĀ if you want to ensure content will transfer even if permissions are not applied due to warnings or failures.

Do not Transfer the item

"failures": "exceptions"

This applies to platform exceptions only. Halt transfer of item (e.g. a folder's children) when there are platform exceptions while transferring permissions to the destination. This is the default.

Do not Transfer the item

"failures": "deny"

Halt transfer of item when any deny or disinheritance permissions fail to transfer to the destination

"failures": "all"

Includes both "exceptions" and "deny" policies.

...