UPSSO REST API

UPSSO provides REST APIs for integration and automation. Here are the links to the API's available.

1. HOW TO GENERATE REST API CREDENTIAL

To access UPSSO via REST API we need a Client ID and Secret. This document explains how to generate the same.

2. GET TOKEN API

This API will validate the client id & secret and create a new session for REST API calls.

3. TERMINATE SESSION API

This API will terminate the session created by "gettoken" API.

4. AUTHENTICATE USER

This API can be used to enable MFA for custom web applications that do not support SAML protocol. This will validate the user credentials then send out the OTP to the user.

5. VERIFY OTP

This API needs to be always called after the AUTHENTICATE USER API. This API can be used to verify the OTP number entered by the user.

6. ADD USER API

This API can be used to add a new user to UPSSO. If the source is specified as LDAP then this API will create the user in Active Directory too.

7. ENABLE USER API

This API will enable the user. It will return a error message if the user already enabled or doesn't exist.

8. DISABLE USER API

This API will disable the user. A disabled user can not access or login into the UPSSO application.

9. GET USER API

This API is used to get the existing users created in the UPSSO. Using this API, we can get the details for UPSSO/LDAP users

10. DELETE USER API

This API is used to delete a user created in UPSSO. using this API we can delete a user in UPSSO/LDAP.

11. UPDATE USER API

This API updates the user details such as email, phone number, name, 2fa method, etc