Skip to main content

Administration Reference

Two scopes​

ScopeOperates onReachable by
PlatformAll tenantsPlatform administrators only
TenantOne tenant's own configuration and usersThat tenant's administrators

Platform operations cross tenant boundaries and therefore run under a different authorization scope entirely. A tenant administrator cannot reach them.

Tenant states​

StateAccessDataReversible
ActiveNormalRetained—
SuspendedBlockedRetainedYes
DeletedBlockedRetained, soft-deletedYes

Machine credentials​

Long-lived credentials for system-to-system integration, distinct from user tokens.

PropertyBehaviour
RevocationChecked on every request — takes effect immediately
ScopeTenant tokens are bound to their tenant. Platform-level system tokens carry no tenant and operate across all of them — treat those as the most sensitive credential the platform issues.

User tokens are checked against the same revocation list. The difference is failure behaviour: machine credentials fail closed if the list cannot be reached, user tokens fail open.

Configuration snapshots​

A snapshot stores a configuration payload supplied by the caller, retrievable later.

OperationAvailable
Create, list, read, update, delete a snapshotYes
Apply, restore, or roll back a snapshotNo
Diff two snapshotsNo

Snapshots are a record, not a recovery mechanism. Reverting a configuration change means making the reverse change. Do not build a recovery procedure around them.

Identity administration​

Users and groups originate in your identity provider and are mirrored. There is no path that creates one without a corresponding identity there.

PathCreates
Sign-inA user, on first successful authentication into a tenant they can reach
Administrative mirrorA user, from a named provider identity
Group syncGroups, from the provider

A user or group cannot be created from arbitrary input. This is enforced at the database level, not only in application code.

Next​