Skip to main content
This page covers the catalog setup you make as the vendor in the Stigg app. To automate the same setup, use the SDK or the REST API. Prerequisites: a metered feature in a plan the customer is subscribed to, or a credit currency the customer has credits in. A feature check for a customer with no active subscription is denied with NoActiveSubscription.

​
Define entity types

1

Open entity types

In the Stigg app, go to Catalog → Entities. The list shows every entity type in the environment, with its description, attribution keys, and when it was last updated.
Catalog → Entities: entity types list

Catalog → Entities

2

Start a new entity type

Click + New entity type to open the creation drawer.
New entity type, empty

New entity type drawer

3

Fill in the details

  • Display name: a readable label, such as Department. Stigg generates the entity type ID from it, and you can edit the ID.
  • Attribution keys: the dimension keys your usage events carry to identify instances of this type, such as departmentId. Type a key and press Enter to add it. You can add several.
New entity type, filling in

Filling in name and attribution key

New entity type, ready to create

Attribution key added and ready to create

4

Create the entity type

Create the entity type, and it appears in the list.
Entity type created

Newly created entity type with edit option

To change an entity type later, hover its row, click the ⋮ menu, and choose Edit.
Edit entity type

Edit entity type drawer

​
View and manage entities for a customer

1

Open the customer

Go to Management → Customers and open the customer record.
Management → Customers: customers list

Management → Customers

2

Open the Governance tab

Click the Governance tab. The entity hierarchy appears on the left, with each entity’s type in the Type column. Each entitlement column shows current usage against the limit, broken out by scope: node-wide, and per model or other dimension.
Customer Governance tab overview

Customer Governance tab, entity hierarchy with usage

​
Sort and prioritize entities

Use the Order by control, the sliders icon next to the type filter, to rank entities by consumption.
  • Usage ranks by absolute consumption, so the heaviest consumers appear first.
  • Utilization ranks by percentage of limit used, so entities closest to being blocked appear first.
Sort order panel

Order by, Usage vs. Utilization

Sort by Utilization to spot entities about to hit their limit, while there’s still time to raise the budget.

​
Add an entity to a customer

1

Open the Add entity drawer

In the customer’s Governance tab, click + Add entity.
Add entity, empty

Add entity drawer, empty

2

Set the name and type

  • Display name (optional): a readable label, such as Engineering. Stigg generates the entity ID used in API calls from it.
  • Entity type: one of the entity types defined for this environment.
Add entity, entity type dropdown

Selecting an entity type

3

Choose a parent (optional)

Select a Parent entity to place this entity in the hierarchy, such as nesting a user under a team.
Add entity, parent selected

Selecting a parent entity

An entity’s place in the hierarchy is set through its entity entitlements. If the entity has none yet, choosing a parent creates an unlimited one (usageLimit: null, cadence P1M) to place it. Set its limit afterwards in the Governance tab. New entities appear in the hierarchy, with all entitlement columns.
Full governance hierarchy

Full governance hierarchy with all entities and entitlement columns

​
Edit an entitlement value inline

1

Click the cell

In the Governance tab, click the entitlement cell you want to change.
2

Enter the new limit

Type the new limit value, then click the checkmark to save it. If the entitlement is unlimited, click the ∞ toggle first to switch to a numeric limit.
Inline edit entitlement

Inline editing an entitlement value

​
What’s next

Check and ingest

Gate access before consumption and record usage after

Query the governance tree

Fetch usage and budget data for dashboards and admin UIs