Passport Documentation

Getting Started with Passport

1. Introduction

Passport is a platform for user management. It includes APIs and interface for nearly every user feature required by any application. These include:

  • Login

  • Registration

  • Emailing

  • Localization

  • User management

  • Discipline

  • Reporting

  • Much more

2. Overview

Passport is built upon two basic objects: Users and Applications.

2.1. Users

concepts

A user exists globally in Passport and they also have data and other attributes for individual Applications (Applications are discussed below). A user has exactly one email (or optionally a username) and one password that they use to login into your entire enterprise and thereby logs them into all of your Applications via single sign-on.

A user can be registered to one or more applications defined by Passport and each of these registrations can have the following additional information:

  • Zero or more roles for the Application

  • Preferred languages for the Application

  • Free form Application specific data

2.2. Applications

A Passport Application defines a system, tool, backend, mobile app, or any other type of application that a user must login into to use. Within Passport, Applications are defined by a name and a set of user roles.

Some examples of common applications include:

  • A mobile application

  • A web application

Most applications you define in Passport have users that register for and log into it. However, even if your applications have anonymous users such as a free-to-play game, you can still create a User inside Passport using the device Id as the unique identifier for the user (i.e. the username). This will allow you to track and manage the user from Passport.

Another example of an application is how we use Passport at Inversoft. We are using Passport to manage users with accounts on https://www.inversoft.com. Therefore, we defined a Passport Application named WWW. This Application has two roles it will use. These roles are:

  • admin

  • user

Here is a diagram that illustrates how our WWW Application is configured in Passport.

www application

When we authenticate a user to our website, we verify the user credentials are correct and that they are registered for the WWW Application. A successful login attempt returns the user’s unique Id which can be used to retrieve the user’s complete profile including their roles for the specific Application. This allows us to control the features and functions we allow the user.

3. Getting Started

There are two difference versions of Passport: Passport Cloud and Passport Server.

3.1. Passport Cloud

Passport Cloud is a hosted solution that is maintained and monitored by Inversoft. When you sign up for Passport Cloud, Inversoft provisions a Private Cloud Server for you in our Cloud environment. You don’t need to download or install Passport if you are using this version. Once your Passport Cloud server is setup, you can immediately access it and begin your integration.

If you are using Passport Cloud, you don’t need to install Passport. Instead, you can dive right into our Tutorials, API docs and User Guide to get started:

3.2. Passport Server

Passport Server is an on-premise solution that is downloaded and installed on your servers. You can install and configure Passport however you want and can also put Passport behind a firewall or VPN. This solution requires that you download and install Passport yourself as well as maintain and monitor it as well.

If you are using Passport Server, you first need to install and configure Passport before starting your integration. Here are some links to get you started:

3.3. FAQ

How do I gain access to the software and my license ID?
Login to our accounts section of the web site at [http://www.inversoft.com/account](http://www.inversoft.com/account).