UNPKG

@loopback/docs

Version:

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

github.com/loopbackio/loopback-next/tree/master/docs

loopbackio/loopback-next

81 lines (41 loc) • 1.67 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
--- lang: en title: 'API docs: authentication-passport.strategyadapter.authenticate' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-passport permalink: /doc/en/lb4/apidocs.authentication-passport.strategyadapter.authenticate.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/authentication-passport](./authentication-passport.md) &gt; [StrategyAdapter](./authentication-passport.strategyadapter.md) &gt; [authenticate](./authentication-passport.strategyadapter.authenticate.md) ## StrategyAdapter.authenticate() method The function to invoke the contained passport strategy. 1. Create an instance of the strategy 2. add success and failure state handlers 3. authenticate using the strategy **Signature:** ```typescript authenticate(request: Request, options?: AuthenticateOptions): Promise<UserProfile | RedirectRoute>; ``` ## 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. </td></tr> <tr><td markdown="1"> options </td><td markdown="1"> AuthenticateOptions </td><td markdown="1"> _(Optional)_ Options passed through to strategy.authenticate. </td></tr> </tbody></table> **Returns:** Promise&lt;[UserProfile](./security.userprofile.md) \| [RedirectRoute](./rest.redirectroute.md)<!-- -->&gt;