The Management API offers a set of actions beyond the scope of a single tenant or environment. An environment is a higher-order structure where MATTR VII tenants are hosted in a specific MATTR VII 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.
You can currently use the Management API to create, delete and list tenants, and also to list your enviornments.
Most list operations in the API use pagination that can be controlled by a cursor method using the cursor
and limit
query parameters.
Example on Retrieve List of Credentials
GET https://manage.mattr.global/v1/tenants
?limit=100
&cursor=Y3JlYXRlZEF0PTIwMjAtMTAtMDhUMjMlM0ExMyUzQTE3Ljg5NtZGUxZWEyNzQ4MWI4
- The
nextCursor
is found at the start of each returned range of credential entries and identifies the last object in the list. - The
limit
determines how many entries are returned in that request, with a maximum value of 1000.
Requesting a page after the last value in the list will return an empty data
object.
{
"data": []
}
Not using a query parameter defaults the response to return the first range of credential entries with a limit of 100.
The Management API is a separate set of APIs to MATTR VII. It uses machine-to-machine authentication through its own credentials, which are different from your MATTR VII client credentials.
As part of onboarding you will be provided with the required details to make a call to a dedicated management API authorization provider and receive a bearer token.
This token is then used in an authorization
header on all calls identified as requiring bearerAuth
(this is required for the majority of management operations).