• management
• SDK
• LogsClient

Class LogsClient

Index

Constructors

constructor

Methods

list

Properties

_options

Constructors

constructor

new LogsClient(options: BaseClientOptions): LogsClient

Parameters

• options: BaseClientOptions

Returns LogsClient

Methods

list

list(
id: string,
request?: ListUserLogsRequestParameters,
requestOptions?: LogsClient.RequestOptions,
): Promise<Page<Log, UserListLogOffsetPaginatedResponseContent>>

Retrieve log events for a specific user.

Note: For more information on all possible event types, their respective acronyms and descriptions, see Log Event Type Codes.

For more information on the list of fields that can be used in sort, see Searchable Fields.

Auth0 limits the number of logs you can return by search criteria to 100 logs per request. Furthermore, you may only paginate through up to 1,000 search results. If you exceed this threshold, please redefine your search.

Parameters

• id: string

ID of the user of the logs to retrieve

• request: ListUserLogsRequestParameters = {}
• OptionalrequestOptions: LogsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<Log, UserListLogOffsetPaginatedResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.users.logs.list("id", { page: 1, per_page: 1, sort: "sort", include_totals: true })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods list Properties _options