The Identity Reporting Module incorporates several REST APIs that enable different features within the reporting functionality. The Reporting Module provides support for the following REST APIs:
Non-Managed Application REST API
Managed Application REST API
Authentication REST API
Reporting REST API
The REST APIs for reporting use the OAuth2 protocol for authentication.
The installation program deploys a special API WAR file, rptdoc.war, which contains the documentation of REST services needed for reporting. On Tomcat and JBoss, the rptdoc.war is automatically deployed when Reporting Module is installed. On WebSphere, the war is installed in the %Reporting-install-folder%. For example: /opt/netiq/idm/apps/IdentityReporting. You need to manually deploy it like other Reporting WARs.
To access the REST API documentation on the server where Reporting Module is installed, specify the path of /rptdoc in the address bar of your browser. For example, if you installed Reporting on a host called servername on port 8180, you can access the REST API documentation at http://servername:8180/rptdoc. If you installed Reporting using https, substitute https for http.
Be aware that while working in a staging or production environment, you must manually delete the rptdoc.war files and folders from your environment on Tomcat and JBoss. Do not deploy these files on WebSphere.