SimplyWorks.Mtm.Sdk

Package Description


Keywords
License
MIT
Install
Install-Package SimplyWorks.Mtm.Sdk -Version 6.0.3

Documentation

Package Version
SimplyWorks.MTM Nuget

License

Introduction

MTM is a multi-tenant management system that handles setting up users, authenticating them, and authorizing them for program access.

As the owner of a tenant, MTM allows for you to invite an employee, making them users under your tenancy. To authenticate a user, MTM returns a JSON Web Token (JWT), identifying the user's permissions.

MTM SDK

The MTM Client outlines the steps the user takes to enable MTM onto the program and interact with its many properties. To complete a cycle on MTM, call the following functions:

1- Creating the tenant

The first step is to create a tenant by calling the CreateTenant method provided by the SDK, which takes in details in the model of TenantCreate and includes the tenant's name for example.

2- Inviting user to tenancy

Then invite the user to reside under the tenancy, calling Invite. Given the user accepts the invitation, we can move on to the following step in the cycle.

3- Accepting the invitation

The second step is to accept the invitation by calling AcceptInvitation method provided by the SDK, which takes in the details by mode of InvitationAccept.

4- Account Creation

This is when MTM completes the cycle, creating for the logged-in user an account, indentifying their role, and enabling access onto the program under the tenancy. Prompt CreateAccount and your user is ready.

5- Logging in

The user logs in, prompting Login (which takes in details in the AccountLogin model) using their outlined credentials, previously returned by the MTM-generated token.

Additional Properties

Like with most user-based programs, MTM allows users a variety of properties to modify the program's use. (Note: the properties marked with an asterisk are limited to the Administrator and Moderators' use.)

- Changing password on user's end

- Resetting the password

- Seeking sent invitation to user*

- Retrieving invitation*

- Canceling invite*

- Switching Tenants*

- Removing account*

- Adding an account*

- Setting up profile data

- Searching Accounts

Getting support 👷

If you encounter any bugs, don't hesitate to submit an issue. We'll get back to you promptly!