mPass MFA Installation and REST Services

mPass MFA Installation and REST Services

Introduction

mPass is an OATH compliant comprehensive solution for enabling Multi Factor authentication for enterprise applications.

mPass provides HTTP based web services for enterprise applications to enable two factor authentication for their authentication workflow. mPass users can use multiple authentication methods for Multi-factor authentication (MFA).

  1. SMS (OTP Sent via SMS)
  2. Mobile app (User’s need to download the mPass mobile application and activate using the mPass User Portal or QR code sent via email )
    1. For Android users, click the below link to view the Mobile token application: https://play.google.com/store/apps/details?id=sa.com.is.mpass.authenticator&hl=en
    2. For Apple users, click the below link to view the Mobile token application: https://apps.apple.com/vn/app/mpass-authenticator/id6446311853
  3. SMS and Email (OTP Sent via SMS and Email)

Purpose

The purpose of this document is to provide the technical details required for Enterprise application developers to integrate their applications with mPass Authentication Server to enable multifactor authentication for their applications.

Pre-requisites

Before starting the integration with mPass web services, following information should be exchanged between developers and mPass administrators.
  1. To be provided by application developers:
    1. Application server IP (mPass service Caller)
  2. To be provided by mPass administrators:
    1. Host Name/IP of the mPass server
    2. http/https Port number of the mPass server
    3. Channel key for the application server IP provided by the developer

Security

Client Authentication

The enterprise application is provided with a unique API Key to authenticate and identify the caller.

The API Key can be generated from the channels screen. Please ask the mPass administrator to provide a API Key to be generated for the IP address of the application server calling the HTTP Web services. The Web Service clients requesting services should pass this key to the mPass system.

Web Service Integration

The Web Services hosted by mPass Application are HTTP based web services. Software developers who want to integrate with the web services should follow the following guide.

Following is a description of the web service endpoints:

General Requests

Get User MFA Options

This service is used to retrieve the Multi-Factor Options (MFA) such as SMS/Email/Mobile App for a particular user. The enterprise applications can use this to display to the user the required option to choose from.



Send SMS

This service is used to send OTP via SMS to the provided mobile number and user identifier.


Send Email

This service is used to send OTP via Email to the provided email address and user identifier.



Send Push Notification

This service is used to send push notifications to the target user.



Send SMS and Email

This service is used to send OTP via Email to the provided email address and user identifier.



Validate OTP

This service is used to validate OTP sent to user via SMS/Email/Generated on the users mPass mobile app




© 2024 Cerebra All Copyrights Reserved

    • Related Articles

    • mPass MFA Install Windows Agent

      Introduction The mPass authentication server is an OATH compliant comprehensive solution for enabling multi-factor authentication for enterprise applications such as VPN Systems, Outlook Web Access, Active Directory Federation Services, Windows/Linux ...

    • What is mPass MFA?

      Introduction The mPass MFA is an OATH compliant comprehensive solution for enabling Multi-Factor Authentication (MFA) for enterprise applications such as VPN Systems, Outlook Web Access, Active Directory Federation Services (ADFS), Windows/Linux ...

    • mPass administration Portal

      Introduction The mPass authentication server is an OATH compliant comprehensive solution for enabling multi-factor authentication for enterprise applications such as VPN Systems, Outlook Web Access, Active Directory Federation Services, Windows/Linux ...

    • mPass MFA High Level Design

      Introduction The mPass authentication server (AS) is an OATH compliant comprehensive solution for enabling Multi-Factor Authentication (MFA) for enterprise applications such as VPN Systems, Outlook Web Access, Active Directory Federation Services ...

    • mPass MFA User Guide

      Introduction The mPass authentication server is an OATH compliant comprehensive solution for enabling multi-factor authentication for enterprise applications such as VPN Systems, Outlook Web Access, Active Directory Federation Services, Windows/Linux ...