You are here

public function Logs::search in Auth0 Single Sign On 8.2

Retrieves log entries that match the specified search criteria (or list all entries if no criteria is used). Required scope: "read:logs"

@link https://auth0.com/docs/api/management/v2#!/Logs/get_logs

Parameters

array $params Log search parameters to send::

  • Including a restricted "fields" parameter can speed up API calls significantly.
  • Results are paged by default; pass a "page" and "per_page" param to adjust what results are shown.

Return value

mixed

Throws

\Exception Thrown by Guzzle for API errors.

File

vendor/auth0/auth0-php/src/API/Management/Logs.php, line 46

Class

Logs
Class Logs. Access to the v2 Management API Logs endpoint.

Namespace

Auth0\SDK\API\Management

Code

public function search(array $params = []) {
  return $this->apiClient
    ->method('get')
    ->addPath('logs')
    ->withDictParams($params)
    ->call();
}