Package com.okta.sdk.resource.api

Class SystemLogApi

java.lang.Object
com.okta.sdk.resource.api.SystemLogApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class SystemLogApi extends Object

  • Constructor Details

    • SystemLogApi

      public SystemLogApi()

    • SystemLogApi

      public SystemLogApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • listLogEvents

      public List<LogEvent> listLogEvents(String since, String until, String after, String filter, String q, Integer limit, String sortOrder) throws ApiException
      List all System Log events Lists all System Log events See [System Log query](https://developer.okta.com/docs/reference/system-log-query/) for further details and examples, and [System Log filters and search](https://help.okta.com/okta_help.htm?type=oie&id=csh-syslog-filters) for common use cases. By default, 100 System Log events are returned. If there are more events, see the [header link](https://developer.okta.com/docs/api/#link-header) for the `next` link, or increase the number of returned objects using the `limit` parameter. >**Note:** The value of the `clientSecret` property in the System Log is secured by a hashing function, and isn't the value used during authentication.
      Parameters:
      since - Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries (optional, default to 7 days prior to until)
      until - Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries. (optional, default to current time)
      after - Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter (optional)
      filter - Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators). (optional)
      q - Filters log events results by one or more case insensitive keywords. (optional)
      limit - Sets the number of results that are returned in the response (optional, default to 100)
      sortOrder - The order of the returned events that are sorted by the `published` property (optional, default to ASCENDING)
      Returns:
      List<LogEvent>
      Throws:
      ApiException - if fails to make API call

    • listLogEvents

      public List<LogEvent> listLogEvents(String since, String until, String after, String filter, String q, Integer limit, String sortOrder, Map<String,String> additionalHeaders) throws ApiException
      List all System Log events Lists all System Log events See [System Log query](https://developer.okta.com/docs/reference/system-log-query/) for further details and examples, and [System Log filters and search](https://help.okta.com/okta_help.htm?type=oie&id=csh-syslog-filters) for common use cases. By default, 100 System Log events are returned. If there are more events, see the [header link](https://developer.okta.com/docs/api/#link-header) for the `next` link, or increase the number of returned objects using the `limit` parameter. >**Note:** The value of the `clientSecret` property in the System Log is secured by a hashing function, and isn't the value used during authentication.
      Parameters:
      since - Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries (optional, default to 7 days prior to until)
      until - Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries. (optional, default to current time)
      after - Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter (optional)
      filter - Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators). (optional)
      q - Filters log events results by one or more case insensitive keywords. (optional)
      limit - Sets the number of results that are returned in the response (optional, default to 100)
      sortOrder - The order of the returned events that are sorted by the `published` property (optional, default to ASCENDING)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<LogEvent>
      Throws:
      ApiException - if fails to make API call

    • listLogEventsPaged

      public Iterable<LogEvent> listLogEventsPaged(String since, String until, String after, String filter, String q, Integer limit, String sortOrder)
      List all System Log events (Paginated) Lists all System Log events See [System Log query](https://developer.okta.com/docs/reference/system-log-query/) for further details and examples, and [System Log filters and search](https://help.okta.com/okta_help.htm?type=oie&id=csh-syslog-filters) for common use cases. By default, 100 System Log events are returned. If there are more events, see the [header link](https://developer.okta.com/docs/api/#link-header) for the `next` link, or increase the number of returned objects using the `limit` parameter. >**Note:** The value of the `clientSecret` property in the System Log is secured by a hashing function, and isn't the value used during authentication. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      since - Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries (optional, default to 7 days prior to until)
      until - Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries. (optional, default to current time)
      after - Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter (optional)
      filter - Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators). (optional)
      q - Filters log events results by one or more case insensitive keywords. (optional)
      limit - Sets the number of results that are returned in the response (optional, default to 100)
      sortOrder - The order of the returned events that are sorted by the `published` property (optional, default to ASCENDING)
      Returns:
      Iterable<LogEvent> lazy iterable over all pages

    • listLogEventsPaged

      public Iterable<LogEvent> listLogEventsPaged(String since, String until, String after, String filter, String q, Integer limit, String sortOrder, Map<String,String> additionalHeaders)
      List all System Log events (Paginated with additional headers) Lists all System Log events See [System Log query](https://developer.okta.com/docs/reference/system-log-query/) for further details and examples, and [System Log filters and search](https://help.okta.com/okta_help.htm?type=oie&id=csh-syslog-filters) for common use cases. By default, 100 System Log events are returned. If there are more events, see the [header link](https://developer.okta.com/docs/api/#link-header) for the `next` link, or increase the number of returned objects using the `limit` parameter. >**Note:** The value of the `clientSecret` property in the System Log is secured by a hashing function, and isn't the value used during authentication. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      since - Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries (optional, default to 7 days prior to until)
      until - Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries. (optional, default to current time)
      after - Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter (optional)
      filter - Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter) and [Operators](https://developer.okta.com/docs/api/#operators). (optional)
      q - Filters log events results by one or more case insensitive keywords. (optional)
      limit - Sets the number of results that are returned in the response (optional, default to 100)
      sortOrder - The order of the returned events that are sorted by the `published` property (optional, default to ASCENDING)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<LogEvent> lazy iterable over all pages

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()