Retention policy assignment

The retention policy assignment endpoint provides a way for admins to apply a retention policy on a per-folder basis, or place a blanket policy over the entire enterprise.

string
11446498

The unique identifier for this retention policy assignment

string
retention_policy_assignment

Value is always retention_policy_assignment

string / date-time
2012-12-12T10:53:43-08:00

When the retention policy assignment object was created

A mini user object representing the user that created the retention policy assignment object

11446498

The unique identifier for this user

user

Value is always user

string / email
ceo@example.com

The primary email address of this user

Aaron Levie50

The display name of this user

The type and id of the content that is under retention. The type can either be folder or enterprise.

11446498

The unique identifier for this object

file

The type for this object

A mini retention policy object representing the retention policy that has been assigned to this content

12345

The unique identifier that represent a file version.

file_version

Value is always file_version

permanently_delete

The disposition action of the retention policy. This action can be permanently_delete, which will cause the content retained by the policy to be permanently deleted, or remove_retention, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy has expired.

Value is one of permanently_delete,remove_retention

Some Policy Name

The name given to the retention policy

3651

The length of the retention policy. This length specifies the duration in days that the retention policy will be active for after being assigned to content. If the policy has A policy_type of indefinite, the retention_length will also be indefinite.

Response Example

{
  "id": 11446498,
  "type": "retention_policy_assignment",
  "assigned_at": "2012-12-12T10:53:43-08:00",
  "assigned_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "assigned_to": {
    "id": 11446498,
    "type": "file"
  },
  "retention_policy": {
    "id": 12345,
    "type": "file_version",
    "disposition_action": "permanently_delete",
    "policy_name": "Some Policy Name",
    "retention_length": 365
  }
}