User Audit Report

Generates a user audit report in the system and writes the report to the filename provided. The report contains the details regarding the users logged into the system in a given time range. This report can then be downloaded using the download command.

This is an asynchronous command, so use the job status URI to determine whether the operation is complete.

This API is version v1.

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See About the REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Table 8-38 User Audit Report

Task Request REST Resource
User Audit Report POST


REST Resource

POST /interop/rest/{api_version}/reports?q={type=userauditreport,fileName=userauditreport.csv,since=2017-12-10,until=2018-06-10}


Supported Media Types: application/x-www-form-urlencoded

The following table summarizes the request parameters.

Table 8-39 Parameters

Name Description Type Required Default
api_version Specific API version Path Yes None
fileName File where report is to be populated Query Yes None
since Report generation start date Query Yes None
until Report generation end date Path Yes None
type Type of report being generated, provisionreport or userauditreport Query Yes None


Supported Media Types: application/json

Table 8-40 Parameters

Parameters Description
details In case of errors, details are published with the error string
status See Migration Status Codes
links Detailed information about the link
href Links to API call
action The HTTP call type
rel Can be self and/or Job Status. If set to Job Status, you can use the href to get the status of the import operation
data Parameters as key value pairs passed in the request

Example of Response Body

The following shows an example of the response body in JSON format.

   "links": [
         "rel": "self",
         "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>,%22until%22:%222016-06-10%22,%22type%22:%22userauditreport%22,%22since%22:%222017-12-10%22%7D",
         "data": null,
         "action": "POST"
         "rel": "Job Status",
         "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>",
         "data": null,
         "action": "GET"
   "status": -1,
   "details": null

User Audit Report Sample Code

Example 8-28 Java Sample –

Prerequisites: json.jar

Common Functions: See CSS Common Helper Functions for Java

public void userAuditReport (String fileName, String type, String since, String until) throws Exception {
	JSONObject params = new JSONObject();

	String urlString = String.format("%s/interop/rest/%s/reports?q=%s", serverUrl, lcmVersion, params.toString());
	String response = executeRequest(urlString, "POST", params.toString(), "application/x-www-form-urlencoded");
	waitForCompletion(fetchPingUrlFromResponse(response, "Job Status"));}
// END 

Example 8-29 cURL Sample –

Prerequisites: jq (

Common Functions: See Common Helper Functions for cURL

funcUserAuditReport () {
     param=$(echo "q={type:$reporttype,fileName:$fileName,since:$since,until:$until}" | sed -f urlencode.sed)  

     funcExecuteRequest "POST" $url $param "application/json"

     output='cat response.txt'
     status='echo $output | jq '.status''
    if [ $status == -1 ]; then
        echo "copying snapshot in progress"
		funcGetStatus "GET"
        error='echo $output | jq '.details''
        echo "Error occured. " $error
	funcRemoveTempFiles "respHeader.txt" "response.txt"

Example 8-30 Groovy Sample – userauditreport.groovy

Prerequisites: json.jar

Common Functions: See CSS Common Helper Functions for Groovy

def userAuditReport (fileName, type, since, until) {
        def url;
        JSONObject param = new JSONObject();		
		try {		    	    			

			url = new URL(serverUrl + "/interop/rest/" + lcmVersion + "/reports?q=" + param.toString());
		} catch (MalformedURLException e) {
			println "Malformed URL. Please pass valid URL"
		response = executeRequest(url, "POST", param.toString(), "application/x-www-form-urlencoded");
		if (response != null) {
			waitForCompletion(fetchPingUrlFromResponse(response, "Job Status"));

Additional Sample Code