4.0 REST Services for Reporting

Identity Reporting incorporates several REST APIs that enable different features within the reporting functionality. Identity Reporting 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. The rptdoc.war is automatically deployed when Identity Reporting is installed on Tomcat application server.

To access the REST API documentation on the server where Identity Reporting is installed, specify the path of /rptdoc in the address bar of your browser. For example, if you installed Identity Reporting on a host called servername on port 8180, you can access the REST API documentation at http://servername:8180/rptdoc. If you installed Identity 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.