medusa-store/docs/content/references/services/classes/AuthService.md

Class: AuthService

Can authenticate a user based on email password combination

Hierarchy

• TransactionBaseService

  ↳ AuthService

Constructors

constructor

• new AuthService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/auth.ts:22

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

---

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

medusa/src/services/auth.ts:20

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

---

userService_

• Protected Readonly userService_: UserService

Defined in

medusa/src/services/auth.ts:19

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the transactional work to be done
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

authenticate

▸ authenticate(email, password): Promise<AuthenticateResult>

Authenticates a given user based on an email, password combination. Uses scrypt to match password with hashed value.

Parameters

Name	Type	Description
email	string	the email of the user
password	string	the password of the user

Returns

Promise<AuthenticateResult>

success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message

Defined in

medusa/src/services/auth.ts:95

---

authenticateAPIToken

▸ authenticateAPIToken(token): Promise<AuthenticateResult>

Authenticates a given user with an API token

Parameters

Name	Type	Description
token	string	the api_token of the user to authenticate

Returns

Promise<AuthenticateResult>

success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message

Defined in

medusa/src/services/auth.ts:52

---

authenticateCustomer

▸ authenticateCustomer(email, password): Promise<AuthenticateResult>

Authenticates a customer based on an email, password combination. Uses scrypt to match password with hashed value.

Parameters

Name	Type	Description
email	string	the email of the user
password	string	the password of the user

Returns

Promise<AuthenticateResult>

success: whether authentication succeeded user: the user document if authentication succeded error: a string with the error message

Defined in

medusa/src/services/auth.ts:144

---

comparePassword_

▸ Protected comparePassword_(password, hash): Promise<boolean>

Verifies if a password is valid given the provided password hash

Parameters

Name	Type	Description
password	string	the raw password to check
hash	string	the hash to compare against

Returns

Promise<boolean>

the result of the comparison

Defined in

medusa/src/services/auth.ts:36

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

withTransaction

▸ withTransaction(transactionManager?): AuthService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

AuthService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20