Class LogsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /logs endpoints.

public class LogsClient : BaseClient, ILogsClient

Inheritance

object

BaseClient

LogsClient

Implements

ILogsClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LogsClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of LogsClient

public LogsClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

GetAllAsync(GetLogsRequest, PaginationInfo, CancellationToken)

Retrieves log entries that match the specified search criteria.

public Task<IPagedList<LogEntry>> GetAllAsync(GetLogsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default)

Parameters

request GetLogsRequest

Specifies criteria to use when querying logs.

pagination PaginationInfo

Specifies pagination info to use when requesting paged results.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<IPagedList<LogEntry>>

An IPagedList<T> containing the list of log entries.

GetAsync(string, CancellationToken)

Retrieves the data related to the log entry identified by id. This returns a single log entry representation as specified in the schema.

public Task<LogEntry> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The identifier of the log entry to retrieve.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<LogEntry>

A LogEntry instance containing the information about the log entry.