auth

Since Kuzzle 1.0.0

Events triggered when a request is sent to the auth controller.


auth:after<Action>

Since Kuzzle 1.0.0

Event type: Pipe

Payload: a Request object

All actions in the auth controller trigger this event after a successful execution. The <Action> part of the event name is replaced with the name of the action, where each word starts with a capital letter.

Example: after a successful logout request, a auth:afterLogout event is triggered.


auth:before<Action>

Since Kuzzle 1.0.0

Event type: Pipe

Payload: a Request object

All actions in the auth controller trigger this event before execution. The <Action> part of the event name is replaced with the name of the action, where each word starts with a capital letter.

Example: before performing a checkToken request, a auth:beforeCheckToken event is triggered.


auth:error<Action>

Since Kuzzle 1.0.0

Event type: Pipe

Payload: a Request object

All actions in the auth controller trigger this event after a failed execution. The <Action> part of the event name is replaced with the name of the action, where each word starts with a capital letter.

Example: after a failed login request, a auth:errorLogin event is triggered.


auth:strategyAuthenticated

Since Kuzzle 1.0.0

Event type: Pipe

Payload: Object (see below)

This event is triggered immediately after a successful user authentication, but before a token is generated (and before an auth:afterLogin event is triggered).

This event's payload is a plain JSON object with the following properties: