Passport Documentation

API Overview

1. Overview

Passport provides a number of APIs that allow you to integrate your application with Passport. All of the Passport APIs are RESTful and return JSON. This means that you will contact the API using the standard HTTP protocol.

The Passport APIs are also synchronous. When you call an API, Passport will process the request and then immediately return a response.

There are 15 groups of APIs:

  • Application APIs - These APIs allow you to manage Applications (CRUD operations) as well as Roles defined for each Application.

  • User APIs - These APIs allow you to manage Users (CRUD operations) as well as the User’s security information such as passwords and verification status.

  • Registration APIs - These APIs allow you to manage the relationship between Users and Applications, also known as Registrations (CRUD operations).

  • Login APIs - These APIs allow you authenticate Users.

  • JWT APIs - These APIs allow you to manage Refresh Tokens, verify Access Tokens and retrieve public keys used for verifying JWT signatures.

  • User Action APIs - These APIs allow you to manage User Actions which are the definitions of actions that can be taken on Users (CRUD operations).

  • User Action Reason APIs - These APIs allow you to manage User Action Reasons which are used when you action Users (CRUD operations).

  • User Comment APIs - These APIs allow retrieve or create comments on Users.

  • Actioning Users APIs - These APIs allow you to take actions on Users or modify previous actions (CRUD operations).

  • Email APIs - These APIs allow you both manage Email Templates (CRUD operations) as well as send emails to Users.

  • Webhook APIs - These APIs allow you manage Webhooks (CRUD operations).

  • Report APIs - These APIs allow you retrieve reporting information from Passport.

  • Audit Log APIs - These APIs allow you update or query the Audit Log.

  • System - These APIs allow you to retrieve and update the system configuration.

  • Status - This API provides you status information about Passport.

Note: Null values in JSON are not allowed on any of the Passport APIs. If you are looking to pass in a null value, simply omit it from your request instead. This will allow Passport to handle default values correctly.