Enterprise Vault™ Discovery Accelerator Administrator's Guide
- Introducing Discovery Accelerator
- Overview and latest updates
- Configuring Compliance Accelerator Desktop Client
- Importing configuration data from an XML file
- Setting Discovery Accelerator system configuration options
- Setting up and assigning roles
- Working with cases
- Setting up review marks and tags
- Using rules to mark and tag items automatically
- Using Custodian Manager
- Searching for items
- About searching with Discovery Accelerator
- Defining email targets with Address Manager
- Building Discovery Accelerator search schedules
- Manually reviewing items
- About reviewing with Discovery Accelerator
- Searching within the review set
- Deleting items from Enterprise Vault archives
- Working with research folders
- Exporting and producing items
- About exporting and producing items
- Creating and viewing reports
- Enhanced reporting
- Available Discovery Accelerator reports
- Accessing reports through the OData web service
- Appendix A. Enterprise Vault properties for use in Discovery Accelerator searches
- Appendix B. Troubleshooting
- Issues with Custodian Manager
Authentication
To ensure the security and integrity of data access, the Reporting API requires authentication. Authentication is used to verify the identity of the requesting client or application and determine whether it has the necessary permissions to access the API resources. There are two primary authentication methods supported for this API:
Upon configuring the reporting endpoint API, a Base URL, a primary and secondary API Keys are generated. Include either primary or secondary API key in the
header of your API requests.For example,
X-API-Key:<Primary or Secondary API Key>
Basic Authentication is a method where API clients provide a username and password with each request. Users use an encoded string in the Authorization header for this method. The recipient of the request uses this string to verify the users' identity and their access rights to a resource.
For example,
Authorization: Basic <Base64 encoded credentials>
To generate a Base64 encoded credentials:
Combine the credentials (username and password) with a colon (:).
Note:
The username must be
. The password must be either a primary or a secondary API Key provided after configuring the reporting endpoint. Use either one as your password.For example, ReportingApiUser:32adasdf3asdcvzxcweasd
After specifying the credentials as mentioned in the step above, generate a Base64 encoded credentials. It is required while setting authorization header.
For example, dGVuYW50OmtleQ==
Therefore, requests made by this user would be sent with the following header:
Authorization: Basic dGVuYW50OmtleQ==
When a server receives this request, it can access the Authorization header, decode the credentials, and look up the user to determine whether access to the requested resource should be allowed.