Version 2021
Badge app single sign-on API reference
You can integrate a third-party native mobile app with the Badge app through this API. Your mobile server and mobile app must make the API calls that are required to communicate with Badge. This documentation explains how to programmatically access Badge’s mobile SSO functionality using the required API calls.
When you integrate your third-party mobile app with Badge by using this API, users of your mobile app use Badge as the authentication provider. Your users must have the Badge app and a valid badge installed on their smart phone. For detailed steps to create a Badge network, add users to the network, and distribute badges, see the MicroStrategy Identity Help.
The workflow for authenticating a user of your third-party mobile app using Badge is described below.
To work with a sample app and mobile server that implements the Badge single sign-on SDK, register your app in Identity Manager, then download the sample SDK files.
Prerequisites
| • | Before you use this API documentation, you should be familiar with the following: |
- JSON notation
- REST API concepts
- Mobile deep linking concepts
- Your third-party mobile app must be a native mobile app.
- It is recommended that you support logging on your third-party mobile app and third-party mobile server. For example, you can log the requests that are made and received, whether requests are granted, how much time is spent servicing each request, and so on. Logging can be useful for auditing and for troubleshooting issues.
- Your third-party mobile server must communicate with Identity Server over a secure channel, such as HTTPS. It is strongly recommended that your third-party mobile server and third-party mobile app also communicate over a secure channel.
Configuring your third-party mobile server
Your third-party mobile server must support making the following calls:
- Create a single sign-on (SSO) session
- Check whether a user has logged in
- Retrieve a user's badge information
Configuring your third-party mobile app
Your third-party mobile app must provide a method for users to start the Badge authentication:
Your mobile app should support making the following calls against your third-party mobile server:
- Request session between third-party server and third-party app
- Close session between third-party server and third-party app
Optionally, your mobile app can request additional information about Badge users: