Use this guide to configure the API tab in the Web Admin for each SecureAuth IdP realm. This tab includes options for generating API credentials and enabling / disabling specific API functionality.
SecureAuth APIs use GET and POST / PUT HTTP requests in adherence with RESTful programming best practices. These endpoints enable secure end-user Authentication and Identity Management (IdM) operations within the context of custom software applications. The Login for Endpoints API lets end-users log on Windows / Mac workstations on the network using a valid Multi-Factor Authentication method.
See the following guides for more information and to configure pertinent API endpoints:
Create a New Realm for the target resource on which the configuration settings apply
1. Check Enable API for this realm to enable the use of SecureAuth IdP APIs on this realm
This option acts as a global on / off switch for APIs on the realm, but the specific options in the API Permissions section below must also be checked in order to use Authentication, IdM, and Login for Endpoints APIs
If the Enable API for this realm option is selected but none of the API Permissions options below are checked, then the end-user can only access the dfp and js endpoints (see Authentication API Guide)
2. Under API Credentials click Generate Credentials to generate a unique Application ID and Application Key for the realm
These values are used as a means of communication to the SecureAuth API endpoints and are included in the application headers to make calls to the endpoints
To configure the Login for Endpoints API, check Enable Login for Endpoints API and then click Configure Login for Endpoints Installer
Use the Login for Endpoints Installer Configuration page to configure the API endpoint for Windows or Mac workstations on the network which end-users can access via a valid Multi-Factor Authentication method