reset-password.md

Reset password

1. Concept

%%{
  init: {
    'theme': 'forest'
  }
}%%
sequenceDiagram
    
    actor User
    participant Frontend
    participant Backend
    participant Auth

    Frontend->>Backend: 1. Request password change
    Backend->>Auth: 2. Request password change token
    Auth->>Backend: 3. Receive token
    Backend->>User: 4. Send link with the token
    User ->> Frontend: 5. Navigate to password change page
    Frontend->>Auth: 5. Request password change with token

Loading

2. Core setup

None! Resetting password works out of the box

3. Backend setup

First, get the api key from Auth Core logs during first boot. You can also read them from file called secret.

Add AuthModule and AdminModule to your application. Set the apiKey to the key fetched earlier.

@Module({
  imports: [
    AuthModule.forRoot({
      global: true,
      core: {
        host: 'AUTH HOST',
        apiKey: 'API KEY'
      }
    }),
    AdminModule
  ],
})
export class AppModule {}

Next, create an endpoint for resetting the password. Use AuthUserRepository for easy communication with the Core.

@Controller()
export class ExampleController {

  constructor(private readonly authUserRepository: AuthUserRepository) {
  }

  @Post()
  public async resetPassword(@User() user: UserDto) {
      const { token } = await this.authUserRepository.generateChangePasswordToken(user.id);
      
      // Logic to send the token to the user
      await this.someEmailSender.sendEmail('resetPasswordEmail', {token})
  }
}