com.descope.sdk.mgmt.AuditService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation

Java library used to integrate with Descope.

The newest version!

package com.descope.sdk.mgmt;

import com.descope.exception.DescopeException;
import com.descope.model.audit.AuditCreateRequest;
import com.descope.model.audit.AuditSearchRequest;
import com.descope.model.audit.AuditSearchResponse;

/** Provides audit records search capabilities. */
public interface AuditService {
  /**
   * Search the audit trail and retrieve audit records based on the given filter. All filter fields
   * are optional and audit may search up to 30 days of history.
   *
   * @param request request is optional, and if provided, all attributes within it are optional.
   * @return {@link AuditSearchResponse}
   * @throws DescopeException If there occurs any exception, a subtype of this exception will be thrown.
   */
  AuditSearchResponse search(AuditSearchRequest request) throws DescopeException;

  /**
   * Create an audit event.
   *
   * @param request the parameters for the event
   * @throws DescopeException If there occurs any exception, a subtype of this exception will be thrown.
   */
  void createEvent(AuditCreateRequest request) throws DescopeException;
}