UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

65 lines (34 loc) 1.28 kB
--- lang: en title: 'API docs: authentication.authenticateactionprovider.action' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/authentication permalink: /doc/en/lb4/apidocs.authentication.authenticateactionprovider.action.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/authentication](./authentication.md) &gt; [AuthenticateActionProvider](./authentication.authenticateactionprovider.md) &gt; [action](./authentication.authenticateactionprovider.action.md) ## AuthenticateActionProvider.action() method The implementation of authenticate() sequence action. **Signature:** ```typescript action(request: Request): Promise<UserProfile | undefined>; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> request </td><td markdown="1"> Request </td><td markdown="1"> The incoming request provided by the REST layer </td></tr> </tbody></table> **Returns:** Promise&lt;[UserProfile](./security.userprofile.md) \| undefined&gt;