SurePassID Postman Collection Guide

SurePassID Authentication Server

Introduction

The SurePassID Postman collections allow developers, testers, and quality assurance teams to easily test the SurePassID REST API using Postman. There are three SurePassID API collections you can choose from depending on the functionality you want to use/test:

• SurePassID FIDO 2 API – The API’s for the SurePassID Fido2 server.

• SurePassID UAF API – The API’s for the SurePassID Fido2 server.

• SurePassID API – All SurePassID API’s such as token validation, push token management, user management, token management, etc.

The collection(s) you use determine the type of authentication support that will be part of your application. Regardless of which API from SurePassID you plan to use, the steps to add the API(s) to Postman is the same.

All the SurePassID API Postman collections are JSON files that can be easily imported into postman using the following procedure. Once imported, users can use Postman’s easy to use interface to run API requests.

To get started, select which collection(s) you want to use.

• SurePassID FIDO 2 API (SurePassID FIDO2.postman_collection.json)

• SurePassID UAF (SurePassID UAF API.postman_collection.json)

• SurePassID API (SurePassID API.postman_collection.json)

You can download the collection from:

https://downloads.surepassid.com/SDK/SurePassID_Postman_Collection.zip

Importing the SurePassID collection

The following instructions are based on Postman version 7.2.2 for Windows.

Start the Postman application and locate the action bar on the top of the page.

Locate the “Import” button in the upper left-hand corner of the postman window and click on it.

The import menu provides numerous ways to import an endpoint or a collection of endpoints into postman. In this case you would simply need to either drag and drop the JSON file provided with this document into the space provided. Alternatively, you can click “Choose Files” and use the file explorer window that opens to locate the file in your computer’s file system. Once the JSON file has been imported, a new collection will be added to postman with all the SurePassID REST API endpoints included.

Importing the Environment Variables

Part of the usage of the SurePassID API postman collection is a set of environment variables. These environment variables provide constants to allow for setting a value in one place and then using them in all endpoints. The environment is provided along with this document as well, and instructions for importing into postman are provided below.

Locate the gear icon in the upper right-hand corner of the postman window and click on it.

In the “Manage Environments” window click on the “Import” button.

Click on the “Choose Files” button and locate the postman environment JSON file included with this document. This will import a set of variable names that correlate to variable usages in various endpoints within the collection. In order to set these variable values follow these instructions.

Click on the environment name in the “Manage Environments” window.

Enter values for each of the variables named within the environment, this will provide a value for the variables used in the collection.

Once these steps have been completed, you are now ready to commence testing using the SurePassID API postman collection.