Skip to Content
GuidesSelf Service Portal

Getting started with the Self Service Portal

The MATTR Self Service Portal is built on top of MATTR VII APIs and provides an easy-to-use graphic user interface to effectively manage and oversee tenant management and configuration.

Please contact us to get access to the Self Service Portal.

Create your first tenant

When you log into the portal, the Tenant management screen is displayed by default. If this is your first time using the portal, the first thing you will need to do is create a tenant:

  1. Select the Create/switch tenant button on the top-right side of the screen.
    The All tenants window is displayed, listing any existing tenants.
  2. Select the Create new button.
    The New tenant form is displayed.
  3. Use the Region dropdown list to select the region your tenant will be hosted in.
  4. Use the Tenant subdomain text box to insert a subdomain for your tenant.
  5. Use the Tenant name text box to insert a meaningful and friendly name for your tenant.
  6. Select the Create button to create the new tenant.
  7. Copy the displayed tenant information and record it somewhere safe.

    The client secret is only displayed immediately after the tenant is created. Once you navigate away from this screen, the client secret will be masked and cannot be retrieved again. Ensure you save it securely at this point.

Start using the Portal

After creating your tenant, you can begin managing it through the Self Service Portal’s various features and functionalities:

  • Every action you take in the portal is within the context of a specific tenant. This means that all configurations, settings and data you manage are associated with the selected tenant.
  • Use the drop-down list in the top-left corner to switch between tenants.
  • Use the navigation panel on the left-hand side to access different functionalities.
  • We recommend starting with one of the following tutorials based on your needs:

Roles and permissions

The Portal’s interface adapts based on your role and assigned permissions. This ensures that you only see the tools and options relevant to your responsibilities:

  • When you create a tenant, you are automatically assigned an admin role for that tenant. This role grants you full access to manage all aspects of the tenant.

  • If you are invited to manage a tenant created by someone else, your assigned role may differ. This means you might have access to a limited set of features based on your permissions.

For more details on roles and permissions, refer to the Access Control documentation.

Interact with tenants via APIs

Create a client

To interact with a tenant via APIs, you need to create a client. A client is an application that can access the APIs on behalf of a user or another application. Each client is associated with a specific tenant and has its own set of credentials (client ID and secret) that are used to authenticate API requests and are scoped to specific roles and permissions.

Follow these steps to create a client for a specific tenant in the Self Service Portal:

  1. Open Platform Management in the left navigation panel and select Tenant.
    The tenant management screen appears.
  2. Click Create/Switch Tenant at the top-right.
    The All Tenants window opens.
  3. Click Switch next to the desired tenant.
  4. Under Platform Management, select Users, clients & roles.
  5. Go to the Clients tab and click Create new.
  6. Enter a name to identify the client in the Name field.
  7. Select roles for the client using the checkboxes in the Tenant access section.
  8. Click Create to create the client
  9. Make note of the displayed client credentials (auth_url, tenant_url, client_id and client_secret) as you will need them to interact with the tenant via the APIs.

The client_secret is only displayed immediately after the client is created. Once you navigate away from this screen, the client secret will be masked and cannot be retrieved again. Ensure you save it securely at this point.

Once you have created a client, you can use the MATTR APIs to interact with the tenant.

Additional resources

Guides

Last updated on