Allocating Licenses to Clients¶
Audience: Firm owners and managers · Where: Clients → License allocation
(/clients/allocations), or Manage allocations on the Clients hub.
Overview¶
Your firm buys licenses as pools. Clients don't have licenses of their own: each client draws on the share of your pools that you allocate to it. This page is where you divide your pools across clients.
No allocation, no assessments
A client with no allocation for a license family can't use it. It can't run assessments of that type, and its Attack Surface tab shows that no capacity is allocated. Allocate capacity to every new client before you start work in it.
Only firm owners and managers can open this page. Other users see "Only a firm OWNER or MANAGER can allocate license capacity to clients." If your firm requires multi-factor authentication, changing allocations requires it too.
What you allocate¶
Allocations are set per license family, in the same units your licenses use. See Licenses & Credits for what each license covers.
| License family | Units you allocate |
|---|---|
| External & attack surface | Monthly external IPs, Monitored domains, Monitored assets |
| Internal network | Monthly internal IPs |
| Web app (annual) | Annual web app tests |
| Web app (one-off) | One-off web app credits |
The allocation table¶
The top of the page shows how much of each pool is still unallocated. Below it, the table has one row per client and one column per unit. Each cell shows how much the client has used against its cap:
| Cell | Meaning |
|---|---|
A number such as 40 / 100 |
Used / allocated for this client. |
| no capacity | The client has an allocation of 0 for this unit, so it can't use it. |
| — | Not subdivided. The client has an allocation for this license family but no cap on this unit; the overall pool cap still applies. |
Cells turn amber when a client has used 80% or more of its cap, and red when it reaches the cap (or the cap is 0).
Finding the clients that need attention
Use Search clients… to find a client, or the Capacity filter: No capacity yet, Near or at capacity, or At capacity. You can also hide columns and export the table to CSV.
Allocating to one client¶
- Click Allocate on the client's row (it reads Edit if the client already has an allocation).
- In Allocate capacity —
, enter a value for each unit in the license families you want to give the client. Next to each field Canima shows how much is unallocated in pool (or Unlimited pool) and how much the client has already consumed. - Click Save allocation.
Rules when you save:
- Every unit in a family you touch needs a value. Enter
0to block a unit on purpose. - You can't allocate more than the pool has left. The total across all clients can't exceed your pool.
- A cap can't go below what the client has already used this period.
To take a family away from a client, click Remove allocation for that pool. You can only remove an allocation the client hasn't drawn on yet. If it has, lower each cap to the amount already used instead, so the client can't draw any further capacity from that pool.
Allocating to several clients at once¶
- Tick the clients in the table and click Allocate n.
- Choose a mode:
- Set the same caps: every selected client gets the caps you enter.
- Distribute remaining evenly: Canima splits each pool's remaining capacity equally across the selected clients. Any remainder is left unallocated.
- Click Apply to n.
If no pool has anything left, Distribute remaining evenly shows "No pool has remaining capacity to distribute."
Error messages¶
| Message | What to do |
|---|---|
| Pool oversell: … | The total would exceed your pool. Lower this or another client's allocation, or ask your account manager for a larger pool. |
| Hard-floor violation: … new cap X < currently consumed Y | You tried to set a cap below what the client has already used. Set it to at least Y. |
| Allocation has consumption rows referencing it … | The client has already used this allocation, so it can't be removed. Adjust the caps instead. |
| License is not active | The firm license for this family isn't active. Contact your account manager. |
What clients see¶
Inside a client, the Overview tab shows an Allocated capacity card: what the client has used against each cap, with a Manage allocation link back to this page. A client with nothing allocated shows "No capacity allocated — this client cannot run assessments until you allocate some from the allocation dashboard." Its Assessments page and Attack Surface tab show the same warning with an Allocate capacity button.
Client users don't see your pools: their Licenses page shows only their own allocation.