About API Sessions

API Programming Guide › API Authentication › About API Sessions

About API Sessions

CA User Activity Reporting Module creates a session each time you use an API call. The persistence of these sessions differs depending on the authentication method you use:

User name and password, or session ID-authenticated sessions expire in the same way CA User Activity Reporting Module sessions do, using the Session Timeout value, which is set at 15 minutes by default. You can set the Session Timeout value from the CA User Activity Reporting Module interface.
Certificate-authenticated sessions do not expire except in certain circumstances. The Session Timeout value is suspended, which lets you integrate CA User Activity Reporting Module with a web portal or outside product more easily. However, it can require additional action to avoid unnecessary use of system resources by persistent sessions.

CA User Activity Reporting Module closes certificate-authenticated sessions under the following circumstances:

Closing a browser displaying a graphic component such as a query
Logging out of an outside product
Allowing the user session of an outside product to expire,

The CA User Activity Reporting Module session timer begins to count down, and ends the session after the timeout value you have configured expires.

If many getQueryViewer or getReportViewer calls are in use, there can be a number of open but idle sessions. To reduce the system resources used by such sessions, use the logout command to end a session when an outside product user logs out, or an outside product session ends.