import { TypeList } from "docs-ui"

IAuthModuleService Reference

This section of the documentation provides a reference to the IAuthModuleService interface’s methods. This is the interface developers use to use the functionalities provided by the Auth Module.

<Note>

You should only use the methods in this reference when implementing complex customizations. For common cases, check out available workflows instead.

</Note>

The main service interface for the Auth Module.

Methods

• authenticate
• confirmAuthVerification
• consumePasswordResetToken
• createAuthIdentities
• createAuthMfaChallenge
• createAuthVerificationToken
• createPasswordResetToken
• createProviderIdentities
• deleteAuthIdentities
• deleteProviderIdentities
• disableAuthMfa
• generateAuthMfaRecoveryCodes
• listAndCountAuthIdentities
• listAuthIdentities
• listAuthMfa
• listProviderIdentities
• register
• requestAuthVerification
• retrieveAuthIdentity
• retrieveAuthMfa
• retrieveProviderIdentity
• startAuthMfa
• updateAuthIdentities
• updateProvider
• updateProviderIdentities
• useAuthMfaRecoveryCode
• validateCallback
• verifyAuthMfa
• verifyAuthMfaChallenge