Class: UserPasswordService
User password service
Implements
Constructors
new UserPasswordService()
new UserPasswordService(
userLookupService,passwordCreationService,userPasswordHistoryService?):UserPasswordService
Constructor
Parameters
| Parameter | Type | Description |
|---|---|---|
userLookupService | UserLookupServiceInterface | user lookup service |
passwordCreationService | PasswordCreationServiceInterface | password creation service |
userPasswordHistoryService? | UserPasswordHistoryServiceInterface | - |
Returns
Defined in
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
passwordCreationService | readonly | PasswordCreationServiceInterface | password creation service |
userLookupService | readonly | UserLookupServiceInterface | user lookup service |
Methods
getPasswordStore()
getPasswordStore(
userId):Promise<ReferenceIdInterface<string> &PasswordStorageInterface>
Get the object containing the password store by user id.
Object must have reference id and password storage interface.
Parameters
| Parameter | Type | Description |
|---|---|---|
userId | string | The id of the user that is being updated |
Returns
Promise<ReferenceIdInterface<string> & PasswordStorageInterface>
The user being updated
Implementation of
UserPasswordServiceInterface.getPasswordStore
Defined in
setPassword()
setPassword(
passwordDto,userToUpdateId?,authorizedUser?):Promise<Omit<Partial<PasswordPlainInterface>,"password"> |Omit<Partial<PasswordPlainInterface>,"password"> &Partial<PasswordStorageInterface>>
Set the password (hash) on the user object.
Parameters
| Parameter | Type | Description |
|---|---|---|
passwordDto | Partial<PasswordPlainInterface & PasswordPlainCurrentInterface> | The object containing the password, and optionally the current password. |
userToUpdateId? | string | The id of the user being updated. |
authorizedUser? | AuthenticatedUserInterface | The authorized user |
Returns
Promise<Omit<Partial<PasswordPlainInterface>, "password"> | Omit<Partial<PasswordPlainInterface>, "password"> & Partial<PasswordStorageInterface>>
Implementation of
UserPasswordServiceInterface.setPassword
Defined in
validateCurrent()
protectedvalidateCurrent(target,password?,authorizedUser?):Promise<boolean>
Parameters
| Parameter | Type |
|---|---|
target | ReferenceIdInterface<string> & PasswordStorageInterface |
password? | string |
authorizedUser? | AuthenticatedUserInterface |
Returns
Promise<boolean>
Defined in
validateHistory()
protectedvalidateHistory(user,password?):Promise<boolean>
Parameters
| Parameter | Type |
|---|---|
user | ReferenceIdInterface<string> |
password? | string |
Returns
Promise<boolean>