@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
214 lines (99 loc) • 3.54 kB
Markdown
---
lang: en
title: 'API docs: authentication.authenticateactionprovider'
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.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/authentication](./authentication.md) > [AuthenticateActionProvider](./authentication.authenticateactionprovider.md)
## AuthenticateActionProvider class
Provides the authentication action for a sequence
**Signature:**
```typescript
export declare class AuthenticateActionProvider implements Provider<AuthenticateFn>
```
**Implements:** [Provider](./context.provider.md)<!-- --><[AuthenticateFn](./authentication.authenticatefn.md)<!-- -->>
## Example
```ts
context.bind('authentication.actions.authenticate').toProvider(AuthenticateActionProvider)
```
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[(constructor)(getStrategies, setCurrentUser, setRedirectUrl, setRedirectStatus, options)](./authentication.authenticateactionprovider._constructor_.md)
</td><td markdown="1">
</td><td markdown="1">
Constructs a new instance of the `AuthenticateActionProvider` class
</td></tr>
</tbody></table>
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[getStrategies](./authentication.authenticateactionprovider.getstrategies.md)
</td><td markdown="1">
`readonly`
</td><td markdown="1">
Getter<[AuthenticationStrategy](./authentication.authenticationstrategy.md) \| [AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined>
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[setCurrentUser](./authentication.authenticateactionprovider.setcurrentuser.md)
</td><td markdown="1">
`readonly`
</td><td markdown="1">
[Setter](./context.setter.md)<!-- --><[UserProfile](./security.userprofile.md)<!-- -->>
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[setRedirectStatus](./authentication.authenticateactionprovider.setredirectstatus.md)
</td><td markdown="1">
`readonly`
</td><td markdown="1">
[Setter](./context.setter.md)<!-- --><number>
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[setRedirectUrl](./authentication.authenticateactionprovider.setredirecturl.md)
</td><td markdown="1">
`readonly`
</td><td markdown="1">
[Setter](./context.setter.md)<!-- --><string>
</td><td markdown="1">
</td></tr>
</tbody></table>
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[action(request)](./authentication.authenticateactionprovider.action.md)
</td><td markdown="1">
</td><td markdown="1">
The implementation of authenticate() sequence action.
</td></tr>
<tr><td markdown="1">
[value()](./authentication.authenticateactionprovider.value.md)
</td><td markdown="1">
</td><td markdown="1">
</td></tr>
</tbody></table>