Auth0-PHP

Logs extends ManagementEndpoint
in package
implements LogsInterface

Class Logs.

Handles requests to the Logs endpoint of the v2 Management API.

Tags
see
https://auth0.com/docs/api/management/v2#!/Logs

Interfaces, Classes, Traits and Enums

LogsInterface
Interface LogsInterface.

Table of Contents

$httpClient  : HttpClient
__construct()  : mixed
ManagementEndpoint constructor.
get()  : ResponseInterface
Retrieve an individual log event.
getAll()  : ResponseInterface
Retrieves log entries that match the specified search criteria (or list all entries if no criteria is used).
getHttpClient()  : HttpClient
Get the injected HttpClient instance.
getLastRequest()  : HttpRequest|null
Return an instance of HttpRequest representing the last issued request.
getResponsePaginator()  : HttpResponsePaginator
Return a ResponsePaginator instance configured for the last HttpRequest.
instance()  : static

Properties

Methods

__construct()

ManagementEndpoint constructor.

public final __construct(HttpClient $httpClient) : mixed
Parameters
$httpClient : HttpClient

httpClient instance to use

Return values
mixed

get()

Retrieve an individual log event.

public get(string $id[, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:logs.

Parameters
$id : string

log entry ID to get

$options : RequestOptions|null = null

Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)

Return values
ResponseInterface

getAll()

Retrieves log entries that match the specified search criteria (or list all entries if no criteria is used).

public getAll([array<string|int, mixed>|null $parameters = null ][, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:logs.

Parameters
$parameters : array<string|int, mixed>|null = null

Optional. Additional query parameters to pass with the API request. See @see for supported options.

$options : RequestOptions|null = null

Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)

Return values
ResponseInterface

Search results