System Operations

Block a tenant from accessing strongbox. All existing tokens will be blocked and no new tokens may be generated while the tenant is blocked. The action can be invoked by the tenant itself, the parent tenant, and users with the system-admin capability.

This operation should only be used in an emergency. Under normal operations all root operations should be performed by authenticated users with root privileges. The system must be unsealed for this operation to work. The returned root token is for the system tenant.

Initializes a newly created tenant with a root token and an admin user.

Unblock a previously blocked tenant. Existing tokens will again become valid and new tokens may be generated through the various authentication mechanisms. The action can be invoked by the parent tenant, and by users with the system-admin capability.

The system starts in a sealed state where all secrets are encrypted. In order to use Strongbox it needs to be unsealed by some external entity.

Note that at most 3 unseal attempts may be performed per hour.

Instruct site to deploy new site api ca certificate. This is useful when the site ca certificate has been manually rotated.

Instruct site to deploy new site ca certificate. This is useful when the site ca certificate has been manually rotated.

This action can be used to extract a sealkey for a site. It can then be used in the unseal-remote action to unseal a site that cannot be automatically unsealed, for example, due to connectivity problems.

Quarantine an entire site from connecting to the system. It will automatically rotate any sensitive keys used to encrypt distribution data for all tenants distributed to the site. The site can optionally be instructed to wipe its data. Note that wiping is only possible if the site is connected to the system. Also, once data has been wiped restoring the site to full operation requires all applications to be re-deployed since approle secrets are not restored.

Quarantine a certain host at a site. This operation should be used if the host has been compromised. To undo it requires a re-installation of the quarantined host.

If a site wasn't able to unwrap its site bundle during the initial setup procedure it will not be able to initialize, as the 'strongbox unwrap' action can only be called once (for security reasons). This action will allow the site to attempt one more unwrap - only do so if you know why the site failed to unwrap and you want to allow it to retry.

Unquarantine a previously quarantined site. This is useful if a site previously suspected of being compromised turns out to not having been compromised. The site will receive a new set of keys for the tenants residing on the site. If the site was wiped all applications that use approles must be restarted.

Unquarantine a certain host at a site. This operation should be used if the host has been determined to not be compromised.