Plans

An organisation thinks in kinds of people: staff get 50 GB and every protocol, students 5 GB and no POP3, shared kiosks no mail leaving the organisation. A plan is a set of settings for one kind of person. Everybody on it gets them, and changing the plan changes it for all of them at once.

The examples use the vsx shell function from the Quick start.

What a plan sets

A plan only holds these settings. It never gives anybody an administrative role.

Making plans

On the console, open Plans and choose New plan…. From the command line:

vsx admin plans add Staff --storage 50GB --protocols all --default
vsx admin plans add Students --storage 5GB --no-pop3 --two-step --forwarding off
vsx admin plans show
vsx admin plans change Students --storage 10GB
vsx admin plans remove Students

Every change first shows what it would do: how many people each plan holds before and after, and what changes for them. On the console this preview comes before Save; on the command line, add --dry-run to see it without saving.

Who is on which plan

Each person is on one plan at most, decided in this order:

1. The plan they were put on by name. On the console, from the person’s page. From the command line, vsx admin people plan ada@example.com Students, or none to take them off. You can also give a plan when you add somebody, as a plan column in a file of people, or from your identity provider over SCIM.
2. The first plan whose groups hold them. Give a plan one or more groups: vsx admin plans assign Students --group students@example.com. Groups nested inside count. A group that keeps its own members by a rule (see Mailing lists and groups) puts people on a plan by what the directory says about them. A group made by directory sync maps your directory’s groups to plans.
3. The default plan, if there is one (--default).

People move between plans as soon as their groups change. A suspended person keeps their plan. When a plan is removed, the people put on it by name go back to their groups’ plan or the default.

When a person and their plan disagree

A person’s page shows each value and where it comes from, such as “50 GB, from Staff”, and so does vsx admin people plan after it puts somebody on a plan.

Who can do what

The organisation’s administrators make and change plans. A domain administrator can see them and put the people of their own domains on one; an auditor can see them. Every change is in the audit log.

Where the organisation requires approval for taking second steps away or for changing the access rules, a plan change that would ask fewer people for a second step, or open a protocol to more people, waits for a second administrator too. Its preview does not.

Over the API