The Passport Setup Wizard is designed to make setting up Passport a simple process so you can get back to working on the core features of your application. The step-by-step process only takes a few minutes to prepare Passport to integrate with your application. The basic steps are:
- Creating the initial admin user
- Creating an application
- Creating an API key
- Configuring the SMTP server
Once these are complete, you are able to call the API and start managing users.
To use the Passport Setup Wizard, you will need to access the Passport backend. If Inversoft is hosting your instance in our private cloud, the URL will be located on your Inversoft Account labeled Web Interface. If you have installed Passport on your own system, you will need to know the IP address or hostname where it has been installed. For example, to access Passport on localhost, you would use the following URL http://localhost:9011.
The Passport Setup Wizard: Create an Admin User
On the Passport Setup Wizard first screen, you will be prompted to create the first admin user for the Passport Application. If needed, you can add more admin users to other applications later.
The fields that are required are marked with a red asterisk. Type in an email and password that will be used to log in to the Passport management interface. The password must be at least 8 characters in length to pass validation. The selected time zone will be used to display date and times in your local time and may be selected each time you log into Passport. Click the Submit button when you have completed the form. When complete, you will return to the Dashboard and will see the three remaining items to be configured.
Create an Application
The next step is to create an application. Select the blue Setup button to begin your first application and proceed to the Add Application form.
A Passport Application represents an authenticated resource. Think of it as something that users will log in to. Required fields are marked with a red asterisk. Start by giving your application a name in the name field. We suggest that in most cases you use the name of your application. Next, you will create roles to represent authority levels in your application. If you’re integrating Passport into an existing application, you probably already know what your roles are, such as “admin”, “user”, or “manager”. To add additional roles, click on the Add Role button and enter the name of the role. A description is not required but can be used to let others know what the role represents. If you are not sure at this stage, it is easy to add and modify existing roles after the Application has been created. Click the blue save button when you have completed the form.
Create an API Key
The next step is to create an API key so you may begin your integration and make authenticated API requests. Select the blue Add button in the Missing API Key box to continue to the Add API Key page.
As before, required fields are marked with a red asterisk. You will notice that Passport has already created a unique API Key and pre-filled the Key field. You may use this generated key, or you can change it to something else if you prefer. For more effective and robust security, API keys should be long and difficult to guess. If you are going to create your own API key, be thoughtful about what you choose–once an API has been created, the key value cannot be changed. Again, the description is optional but is helpful to document the purpose or intended use of this API key.
If you do not provide any additional configuration, the API Key will have access to all authenticated APIs. Passport gives you the option to control the use of each key by selecting specific endpoints and HTTP Methods this key will be allowed to access. You may click on a column, row or individual HTTP Method to toggle access to each unique endpoint. Click the blue save button when you have completed the form. To get back to the final step of the Passport Setup Wizard, select Dashboard from the menu on the left.
SMTP Server Configuration
The final item to complete is the SMTP server configuration. This step is not required to use Passport, but is recommended since without it Passport will be unable to send email. This means features such as Setup Password and Forgot Password will not function. Click the blue Setup button in the Email Setting box and you will see the System Settings page.
The Email tab should already be selected. Start by toggling the Email settings “enabled” button and the SMTP server configuration will become visible. As always, required fields are marked with a red asterisk. Enter your host, port, username, and password. You may also select SSL or TLS security. Click the blue save button when you have completed the form and select Dashboard from the menu on the left.
Your dashboard no longer shows the Complete Passport setup panel. Setup is complete and you are ready to start your Passport integration!
For more details on how to use the Passport Setup Wizard or any other functions, please read the complete Passport documentation here.
Video: The Passport Setup Wizard
Learn More About Passport
Passport is designed to be the most flexible and secure Customer Identity and Access Management solution available on the market. More than a login tool, we provide registration, data search, user segmentation and advanced user management across applications. Find out more about Passport and sign up for a free trial today.