Retention policy (Mini)

A mini representation of a retention policy, used when nested within another resource.

string

required

The unique identifier that represents a retention policy.

Example:

"12345"

type

enum<string>

required

The value will always be retention_policy.

Available options:

retention_policy

Example:

"retention_policy"

policy_name

string

The name given to the retention policy.

Example:

"Some Policy Name"

retention_length

string<int32>

The length of the retention policy. This value 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.

Example:

"365"

disposition_action

enum<string>

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.

Available options:

permanently_delete,

remove_retention

Example:

"permanently_delete"