Miridia
Portal
Guides

Users and roles

Invite your team, give each person a role, group people in teams, and create API keys for systems.

A user is a person who signs in to Miridia. A role controls what that person can see and do. An API key lets a system call Miridia with no person present.

Users

Each user has one account for all Miridia products. The same email address and password sign in to the portal, Miridia Planner, and Miridia AI Studio. One user can have access to more than one business, and to more than one organisation.

A user account has a status: Active or Suspended.

Invite a team member

Open the team page

In the portal, go to the settings of the business and open Team.

Send the invitation

Enter the email address of the person and select one or more roles.

The person accepts

Miridia sends an email with a link. The person sets a password and signs in.

To remove a person from one business, remove the employee from that business. The person keeps access to other businesses.

Roles

Each business has system roles. You can also create custom roles.

System roleTypical person
SudoA platform operator. Not for normal use.
AdministratorThe owner of the business. This role has full access.
ManagerA supply chain manager. This role owns products, purchase orders, and transfer orders.
OperationsA person who runs daily operations.
DriverA driver who sees assigned deliveries.
AccountantA person who works with prices, costs, and billing.
GeneralA person with basic access.
SupportA person who helps customers.
UnassignedA person with no role yet.

Permissions

A role gives an action for each module. The actions are None, View, Modify, and Delete.

The modules are Orders, Shipments, Customers, Products, Vehicles, Integrations, TeamAndRoles, Billing, Workflows, Settings, Insights, Suppliers, PurchaseOrders, WorkOrders, TransferOrders, and Schedule.

You can change the permissions of a system role. To go back to the original permissions, restore the defaults of that role. You cannot delete a system role.

Custom roles

Create a custom role when no system role fits. A custom role has a title, a description, a type, a scope, and a permission set. The scope is Branch or Franchise.

Teams

A team is a named group of users with a colour. Use a team to organise work, for example "Night shift" or "Cold room". A team does not change permissions. Roles control permissions.

API keys

An API key lets a system call Miridia. Use a key for an integration, a script, or a workflow engine.

  • A key belongs to the organisation and acts for one business.
  • A key can have scopes. A scope limits the key to some modules and actions. A key with no scopes has no limit.
  • A key can have an expiry time.
  • You can revoke a key at any time.
  • Only an owner of the organisation can create or revoke a key.
Miridia shows the value of a new key once. Store it in a secret store. If you lose the value, revoke the key and create a new one.

Read Authentication for how a client sends the key.

Notifications for users

Miridia tells the administrators when a new user joins the business. Workflows can start on OnUserRegistered.

API reference