@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
367 lines (169 loc) • 5.96 kB
Markdown
---
lang: en
title: 'API docs: authentication-jwt'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt
permalink: /doc/en/lb4/apidocs.authentication-jwt.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/authentication-jwt](./authentication-jwt.md)
## authentication-jwt package
[@loopback/authentication-jwt](https://github.com/loopbackio/loopback-next/tree/master/extensions/authentication-jwt)
## Classes
<table><thead><tr><th>
Class
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[JWTAuthenticationComponent](./authentication-jwt.jwtauthenticationcomponent.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[JWTAuthenticationStrategy](./authentication-jwt.jwtauthenticationstrategy.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[JWTService](./authentication-jwt.jwtservice.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[MyUserService](./authentication-jwt.myuserservice.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[RefreshToken](./authentication-jwt.refreshtoken.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[RefreshTokenRepository](./authentication-jwt.refreshtokenrepository.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[RefreshtokenService](./authentication-jwt.refreshtokenservice.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[SecuritySpecEnhancer](./authentication-jwt.securityspecenhancer.md)
</td><td markdown="1">
A spec enhancer to add bearer token OpenAPI security entry to `spec.component.securitySchemes`
</td></tr>
<tr><td markdown="1">
[User](./authentication-jwt.user.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[UserCredentials](./authentication-jwt.usercredentials.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[UserCredentialsRepository](./authentication-jwt.usercredentialsrepository.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[UserRepository](./authentication-jwt.userrepository.md)
</td><td markdown="1">
</td></tr>
</tbody></table>
## Interfaces
<table><thead><tr><th>
Interface
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[RefreshTokenService](./authentication-jwt.refreshtokenservice.md)
</td><td markdown="1">
The token refresh service. An access token expires in limited time. Therefore token refresh service is needed to keep replacing the old access token with a new one periodically.
</td></tr>
<tr><td markdown="1">
[UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[UserRelations](./authentication-jwt.userrelations.md)
</td><td markdown="1">
</td></tr>
</tbody></table>
## Namespaces
<table><thead><tr><th>
Namespace
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[RefreshTokenConstants](./authentication-jwt.refreshtokenconstants.md)
</td><td markdown="1">
Constant values used when generating refresh token.
</td></tr>
<tr><td markdown="1">
[RefreshTokenServiceBindings](./authentication-jwt.refreshtokenservicebindings.md)
</td><td markdown="1">
Bindings related to token refresh service. The omitted explanation can be found in namespace `RefreshTokenConstants`<!-- -->.
</td></tr>
<tr><td markdown="1">
[TokenServiceBindings](./authentication-jwt.tokenservicebindings.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[TokenServiceConstants](./authentication-jwt.tokenserviceconstants.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[UserServiceBindings](./authentication-jwt.userservicebindings.md)
</td><td markdown="1">
</td></tr>
</tbody></table>
## Variables
<table><thead><tr><th>
Variable
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[OPERATION\_SECURITY\_SPEC](./authentication-jwt.operation_security_spec.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[SECURITY\_SCHEME\_SPEC](./authentication-jwt.security_scheme_spec.md)
</td><td markdown="1">
</td></tr>
</tbody></table>
## Type Aliases
<table><thead><tr><th>
Type Alias
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[Credentials](./authentication-jwt.credentials.md)
</td><td markdown="1">
A pre-defined type for user credentials. It assumes a user logs in using the email and password. You can modify it if your app has different credential fields
</td></tr>
<tr><td markdown="1">
[RefereshTokenWithRelations](./authentication-jwt.refereshtokenwithrelations.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[SecuritySchemeObjects](./authentication-jwt.securityschemeobjects.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[TokenObject](./authentication-jwt.tokenobject.md)
</td><td markdown="1">
Describes the token object that returned by the refresh token service functions.
</td></tr>
<tr><td markdown="1">
[UserCredentialsWithRelations](./authentication-jwt.usercredentialswithrelations.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[UserWithRelations](./authentication-jwt.userwithrelations.md)
</td><td markdown="1">
</td></tr>
</tbody></table>