Manage tenants

Overview

An environment is a higher-order structure where Sovrin API tenants are hosted in a specific Sovrin API cloud deployment. One tenant must always be a part of exactly one environment. Each environment may include multiple tenants that share hardware resources and environment settings while maintaining authorisation and data isolation.

Sovrin API offers two types of deployment environments:

• Public cloud environments: Multi-tenanted Sovrin API deployments across a range of different customers using shared infrastructure.

• Private cloud environments: Customer-specific Sovrin API deployments in an AWS region of your choosing. Contact us if you're interested in a private environment.

The Management API offers a set of actions beyond the scope of a single tenant or environment. It offers a separate set of APIs to Sovrin API and uses machine-to-machine authentication through its own credentials, which are different from your Sovrin API client credentials.

The following sub-sections walk you through setting up your Management API access and using its different capabilities:

• Authorisation: Obtaining access to the Management APIs.

• Managing tenants: Creating tenants, deleting tenants and retrieving tenant data.

• List environments: Listing your environments.

tip

The Management API is currently only available to select customers. Please contact us if you are interested in this capability.