Interface IApiAuditLogControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IApiAuditLogControllerApiAsync : IApiAccessor

Methods

View Source

GetAuditLogByEventIdAsync(string, DateTime?, DateTime?, int, CancellationToken)

Declaration
Task<AuditLogEventDto> GetAuditLogByEventIdAsync(string eventId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string eventId
DateTime? since

(optional)
DateTime? before

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<AuditLogEventDto>

Task of AuditLogEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAuditLogByEventIdWithHttpInfoAsync(string, DateTime?, DateTime?, int, CancellationToken)

Declaration
Task<ApiResponse<AuditLogEventDto>> GetAuditLogByEventIdWithHttpInfoAsync(string eventId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string eventId
DateTime? since

(optional)
DateTime? before

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<AuditLogEventDto>>

Task of ApiResponse (AuditLogEventDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAuditLogsAsync(DateTime?, DateTime?, string, Guid?, Guid?, Guid?, string, string, string, string, string, int?, string, int, CancellationToken)

Declaration
Task<AuditLogPageDto> GetAuditLogsAsync(DateTime? since = null, DateTime? before = null, string action = null, Guid? userId = null, Guid? actorUserId = null, Guid? targetUserId = null, string resourceType = null, string resourceId = null, string outcome = null, string requestId = null, string ipAddress = null, int? pageSize = null, string cursor = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime? since

(optional)
DateTime? before

(optional)
string action

(optional)
Guid? userId

(optional)
Guid? actorUserId

(optional)
Guid? targetUserId

(optional)
string resourceType

(optional)
string resourceId

(optional)
string outcome

(optional)
string requestId

(optional)
string ipAddress

(optional)
int? pageSize

(optional)
string cursor

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<AuditLogPageDto>

Task of AuditLogPageDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAuditLogsWithHttpInfoAsync(DateTime?, DateTime?, string, Guid?, Guid?, Guid?, string, string, string, string, string, int?, string, int, CancellationToken)

Declaration
Task<ApiResponse<AuditLogPageDto>> GetAuditLogsWithHttpInfoAsync(DateTime? since = null, DateTime? before = null, string action = null, Guid? userId = null, Guid? actorUserId = null, Guid? targetUserId = null, string resourceType = null, string resourceId = null, string outcome = null, string requestId = null, string ipAddress = null, int? pageSize = null, string cursor = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime? since

(optional)
DateTime? before

(optional)
string action

(optional)
Guid? userId

(optional)
Guid? actorUserId

(optional)
Guid? targetUserId

(optional)
string resourceType

(optional)
string resourceId

(optional)
string outcome

(optional)
string requestId

(optional)
string ipAddress

(optional)
int? pageSize

(optional)
string cursor

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<AuditLogPageDto>>

Task of ApiResponse (AuditLogPageDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SearchAuditLogsAsync(AuditLogSearchOptions, int, CancellationToken)

Declaration
Task<AuditLogPageDto> SearchAuditLogsAsync(AuditLogSearchOptions auditLogSearchOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AuditLogSearchOptions auditLogSearchOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<AuditLogPageDto>

Task of AuditLogPageDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SearchAuditLogsWithHttpInfoAsync(AuditLogSearchOptions, int, CancellationToken)

Declaration
Task<ApiResponse<AuditLogPageDto>> SearchAuditLogsWithHttpInfoAsync(AuditLogSearchOptions auditLogSearchOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AuditLogSearchOptions auditLogSearchOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<AuditLogPageDto>>

Task of ApiResponse (AuditLogPageDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call