Version 2021
Identity Developer Resources
The MicroStrategy Badge APIs provide you with programmatic access to Badge functionality. This documentation explains how to use the Badge APIs.
Before you use these APIs, MicroStrategy recommends that you be familiar with the following:
- For the Identity server-side API, Java development concepts
- For the Identity client-side API, iOS and Android development concepts
- JSON notation
- REST API concepts. For the Badge app single sign-on API and the physical access API, the structure of the API definitions is described in Understanding the Badge API document structure.
MicroStrategy Identity API reference
You can create and implement custom uses of Badge to support your unique business needs. You do this by embedding specific Badge functionality into your web or mobile applications. The MicroStrategy Identity API includes server-side APIs for embedding Badge functionality into a third-party server, such as a web or mobile server. The MicroStrategy Identity API also includes client-side APIs for embedding Badge functionality into your third-party mobile client.
Badge app single sign-on API reference
You can enable users of your third-party iOS or Android mobile app to authenticate with Badge by integrating your third-party mobile app with Badge. Users sign in to your app by authenticating with the Badge app.
Physical access control system (PACS) adapter API reference
If your physical access control system (PACS) is not included as an out-of-the-box option in Identity Manager, you can create your own PACS adapter to integrate your PACS with Badge. This PACS adapter enables users to unlock physical resources, such as locked doors or offices, using the Badge app on their smartphones.
SAML web application toolkit: Single sign-on to a web application
You can learn how to integrate a web application with Badge by working with a sample project. The sample project demonstrates how to configure a SAML (Security Assertion Markup Language)-enabled web application to let users sign in by scanning a Badge QR code with the Badge app on their smartphones.