API Programming Guide › About the CA User Activity Reporting Module API

About the CA User Activity Reporting Module API

The CA User Activity Reporting Module API uses a web application that accepts HTTPs post commands to return the query or report information you want. The web application consists of a dedicated iGateway spindle.

You use specific URLs that include arguments to control what data is returned and how it is filtered. Each available URL / API command verifies whether the caller is authenticated by validating the session id or certificate credentials. Each HTTPs request must contain one of these types of authentication information.

CA User Activity Reporting Module API features include:

• Authenticated, secure APIs
• Product registration for single sign-on (SSO)
• Retrieval of a query or report list, filtered by tag
• Display of a query or report in the interactive CA User Activity Reporting Module interface, allowing filtering, and embedding in a user interface

To use CA User Activity Reporting Module API calls effectively, be familiar with the federation structure of your environment, the queries and reports available, and user roles and their access rights.

More information:

CA User Activity Reporting Module API Examples

CA User Activity Reporting Module API Structure

API Authentication

API Call Returns

All API commands, with the exception of getQueryViewer and getReportViewer, return an element in the XML that describes whether the command was successful and if it was not, the reason why.

API Return Example

<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>true</Value> 
<Description>Get Object Successful. Type [getQueryList]</Description> 
<Items>
<Item edit="false">
	<Panel id="Subscription/panels/Unclassified_Event_Detail" name="Unclassified Event Detail" shortname="Detail" subscription="true" type="EventViewer" version="12.0.46.5">
	<Description>Provides event details for unclassified event activity</Description> 

In this case, the result value is “true” indicating success, and the description contains the command executed.

CA User Activity Reporting Module API Structure

A CA User Activity Reporting Module API call uses the HTTPS protocol to contact the event log store. The call returns results in XML, or in the form of a graphical query or report display, depending on the call you use.

Each call has a defined URL structure, consisting of several common elements. For example, an API login call appears this way:

https://ELMSERVER:5250/spin/calmapi/calmapi_login.csp?username=xx&password=xx

The first element defines the target server:

https://ELMSERVER:5250/spin/calmapi/

To use the call in your environment, replace the "ELMSERVER" portion of the URL with the hostname or IP address of the server where the data you want is stored. Port 5250 is the default port used by CA User Activity Reporting Module. The "/spin/calmapi/" text remains the same for any call.

The second element defines the API call itself, and provides any authentication details:

calmapi_login.csp?username=xx&password=xx

"calmapi_login.csp" is the login call. The second portion, "?username=xx&password=xx" defines the credentials that are used to log in. In this case it is a CA User Activity Reporting Module user name and password.

More information:

API Authentication

API Registration