Cloud Administration System Event Log API 
a month ago

Cloud Administration System Event Log API 

The Cloud Administration System Event Log API is a REST-based web services interface that allows administration system log events to be retrieved from Cloud Access Service (CAS). You can use this REST API to download to a Cloud Administration System Event Log API client sofware. For example, you can import the system log events into your security information and event management (SIEM) solution, such as NetWitness, you can write your own custom Administration System Event Log API client software, or use the Java or Python utilities or curl commands in the Admin Rest API package on the RSA Downloads page (RSA Community login is required).

Events are retrieved in chronological order in batches, and do not contain duplicates. They can be filtered by date range. All system events are retained in CAS for 90 days and then purged, so events from the last 90 days are available for download using this API.

For information on audit log messages that describe Helpdesk Administrator and Super Administrator activities, see System Event Monitor Messages for Cloud Access Service.

For information about managing access to this API, see Accessing the Cloud Administration APIs.

 

Authentication

System Event Log API requests require an HTTP Authorization header with a bearer token to authenticate to CAS. The bearer token must be created as described in Authentication for the Cloud Administration APIs.

Software Developer Kit

You can download the API Software Developer Kit (SDK) as the RSA SecurID Access Administration REST API. It is available from the RSA ID Plus Downloads page (RSA Community login is required).

Request Requirements

Use the following method, request URL, body response, response body type, and response codes to retrieve administration events from CAS and deliver them to your API client.

MethodRequest URLResponse BodyResponse Body TypeResponse Codes
GET /AdminInterface/restapi/v1/systemlog/exportlogsMetadata plus array of System log eventsapplication/json200, 400, 403, 429

 

Request Parameters

The System Event Log API allows the following optional parameters.

Note:  The request query parameter values may contain reserve characters that need to be URL encoded. Otherwise, the server may send a 400 Bad Request error. For example, the ISO 8601 Date and Time format may contain the + character if the specific time zone has an offset from UTC, such as+05:30. The + character needs to be encoded as %2B.

 

NameDescriptionTypeDefault ValueExample
startTimeAfterStart time of log events.ISO 8601 Date TimeCurrent time - 1 day2018-05-01T11:22:12.828-05:30
endTimeOnOrBefore End time of log events.ISO 8601 Date TimeCurrent time2018-05-09T21:06:33.125-05:30
pageNumberThe pageNumber parameter will be validated when it exceeds the application's maximum limit of 10,737,417. If this limit is crossed, the system returns an HTTP 400 response.Integer05
pageSizeNumber of records to return in a page (or batch). Value between 1-100. Any value specified outside of this range will be treated as 100.Integer10050

 

Request Examples

The following example displays a REST API request with no parameters.

GET /AdminInterface/restapi/v1/systemlog/exportlogs

Accept: application/json

Authorization: Bearer <bearer token>

The following example shows a REST API request with a specified start time.

GET /AdminInterface/restapi/v1/systemlog/exportlogs?startTimeAfter=2018-05-01T11:22:12.828-05:30

Accept: application/json

Authorization: Bearer <bearer token>

Responses

The following table shows response metadata.

ParameterDescriptionType
totalPagesTotal number of pages (or batches) of results.Integer
totalElementsTotal number of resultsInteger
pageSizeNumber of results returned in a page (or batch)Integer
currentpage

Page number associated with the results returned in the response.

Pages are numbered from 0 to (totalPages - 1).

Integer

 

The following example shows sample response metadata with 684 total results and a default page size of 100.

{

    "totalPages": 7,

    "totalElements": 684,

    "pageSize": 100,

    "currentPage": 0,

    "elements": [
        {

            ......

        }

    ]

}

The following table shows API response data.

ParameterDescriptionType
eventIdIdentifies the event.String
eventAtDate and time when the user event was logged, in the UTC time zone. Example: 2018-05-13T16:29:59.000 UTCISO 8601 Date Time
logLevelEvent log severity level (for example, notice or error).String
descriptorIdSystem event code.String
categorySystem event type.String
descriptionDescription of the system event.String
organizationIdUnique identifier of the organization’s deployment.UUID in String
organizationNameName of the organization’s deployment.String
tenantIdIdentifies the customer's deployment.UUID in String
tenantName of the customer’s deployment.String
serverIpIP Address of the user who generated user events.IP Address in String
additionalTextUser identifier.String
verboseFlagIndicates if verbose details are included.Boolean
createdAtDate and time when the system event was created.ISO 8601 Date Time
updatedAtDate and time when the system event was last updated.ISO 8601 Date Time

 

Example Response

{

    "totalPages": 1,

    "totalElements": 2,

    "pageSize": 100,

    "currentPage": 0,

    "elements": [
        {

            "eventId": "4791a6cc-1194-3af9-6af2-4cbe89040d1b",

            "eventAt": "2025-12-09T11:29:20.653Z",

            "logLevel": "notice",

            "descriptorId": 20150,

            "category": "Identity Router",

            "description": "Identity router successfully connected to Authentication Manager.",

            "organizationId": "ae0dc2e1-c512-4ce1-ad11-636a8dabcd1b",

            "organizationName": "dak-br01-ngx-02",

            "tenantId": "ae0dc2e1-c512-4ce1-ad11-636a8dabcd1b",

            "tenant": "dak-br01-ngx-02",

            "serverIp": "172.24.28.59",

            "additionalText": "AM Agent=AM-EC, AM MFA Rest URL =https://dak-am-primary.access.pontus.rsa.com:5555, EC Host Id=39b18e65-987b-4652-9d97-ed4b7342d2b3",

            "verboseFlag": false,

            "createdAt": "2025-12-09T11:29:20.653Z",

            "updatedAt": "2025-12-09T11:29:20.653Z"

        },
        {

            "eventId": "2beb4ee6-3e1d-e140-d006-606d753318e3",

            "eventAt": "2025-12-09T11:30:50.657Z",

            "logLevel": "notice",

            "descriptorId": 20150,

            "category": "Identity Router",

            "description": "Identity router successfully connected to Authentication Manager.",

            "organizationId": "ae0dc2e1-c512-4ce1-ad11-636a8dabcd1b",

            "organizationName": "dak-br01-ngx-02",

            "tenantId": "ae0dc2e1-c512-4ce1-ad11-636a8dabcd1b",

            "tenant": "dak-br01-ngx-02",

            "serverIp": "172.24.28.59",

            "additionalText": "AM Agent=AM-EC, AM MFA Rest URL =https://dak-am-primary.access.pontus.rsa.com:5555, EC Host Id=39b18e65-987b-4652-9d97-ed4b7342d2b3",

            "verboseFlag": false,

            "createdAt": "2025-12-09T11:30:50.657Z",

            "updatedAt": "2025-12-09T11:30:50.657Z"

        }

    ]

}

Response Codes

The following table shows response codes and descriptions for this API.

CodeDescription
200The request was successful.
400Invalid or missing request parameters.
403Not authorized to perform the request.
429Too many requests.