APTARE IT Analytics Release Notes
- Introduction
- Patch release for version 10.6.00
- Patch releases: APTARE IT Analytics
- Patch releases: APTARE IT Analytics
- What's new: Version 10.6.00 highlights
- Supported Systems
- Installations and Upgrades
- Enhancements and Resolved Issues
- Known issues, optimizations, and End-of-Life (EOL)
Access APTARE reports with REST APIs even with SSO configured
The mechanism to use the REST APIs is enhanced enable SSO users to access APTARE reports. With this enhancement, users must generate an API key from the portal and use it to authenticate on Swagger. The portal now allows each user to generate a unique API key that has the following properties:
User can have only one active API key at a time.
The key does not have an expiry date.
Key is displayed only once when it is generated on the portal. Hence, user must copy and save it securely.
If the key goes missing, the user can revoke the existing key and create a new one.
While authenticating the user on Swagger, the key supplied by the user is passed as an authentication header to the portal. The portal authenticates the user based on the API key and uses the user information for further authorization.
Note:
If a user is inactive or removed from the LDAP/IDP, update the APTARE IT Analytics Portal manually to prevent the user from using the REST API. If not done, the user automatically becomes inactive after the configured number of days.
This enhancement enables access to APTARE reports with REST APIs for SSO, LDAP and DB users. See Accessing APTARE Reports with the REST API section in the APTARE IT Analytics System Administrator Guide for the access procedures.
With this enhancement the authentication method has changed from basic to API key. Hence you need to make the required API code/script changes to avoid seeing authentication errors while accessing the report data. The API code will now have to pass the API key for user authentication.