User Auth Functions

The User Auth drop-in provides API functions that enable you to programmatically control behavior, fetch data, and integrate with Adobe Commerce backend services.

Version: 4.0.0

Function	Description
confirmEmail	Completes the customer activation process using the supplied customerEmail and customerConfirmationKey parameters.
createCustomer	Creates a customer account based on the data supplied in the forms parameter.
createCustomerAddress	Defines a new customer address.
getAdobeCommerceOptimizerData	Fetches Adobe Commerce Optimizer data.
getAttributesForm	Retrieves EAV attributes associated with customer and customer address frontend forms.
getCustomerData	Retrieves data about the customer represented by the auth_dropin_user_token cookie value.
getCustomerRolePermissions	Retrieves customer role permissions.
getCustomerToken	Handles the sign-in operation.
getStoreConfig	Calls the storeConfig query to retrieve store configuration data.
requestPasswordResetEmail	Initiates the process of resetting a customer’s password.
resendConfirmationEmail	Resends the email confirmation to the customer using the supplied customerEmail parameter.
resetPassword	Resets a customer’s password using the supplied email, resetPasswordToken, and newPassword parameters.
revokeCustomerToken	Revokes the customer’s token and clears the authentication cookie.
verifyToken	Checks the validity of the provided authentication token.

confirmEmail

The confirmEmail function completes the customer activation process using the supplied customerEmail and customerConfirmationKey parameters. Adobe Commerce sends the confirmation key to the customer when they request to create an account. The function calls the confirmEmail mutation .

const confirmEmail = async (
  { customerEmail, customerConfirmationKey, }: confirmEmailProps
): Promise<confirmEmailResponse | undefined>

Parameter	Type	Req?	Description
customerEmail	string	Yes	The customer’s email address.
customerConfirmationKey	string	Yes	The confirmation key sent by Adobe Commerce.

Events

Does not emit any drop-in events.

Returns

Returns confirmEmailResponse | undefined.

createCustomer

The createCustomer function creates a customer account based on the data supplied in the forms parameter. By default, the function calls the createCustomer mutation . If the apiVersion2 parameter is set to true, the function calls the createCustomerV2 mutation .

const createCustomer = async (
  forms: Customer,
  apiVersion2: boolean
): Promise<CustomerModel>

Parameter	Type	Req?	Description
forms	Customer	Yes	Customer account data including email, password, firstName, lastName, and optional custom attributes.
apiVersion2	boolean	Yes	Whether to use the v2 API (createCustomerV2 mutation) instead of the original createCustomer mutation.

Events

Does not emit any drop-in events.

Returns

Returns CustomerModel.

createCustomerAddress

The createCustomerAddress function defines a new customer address. The customer can subsequently designate the address for billing or shipping orders. The function calls the createCustomerAddress mutation .

const createCustomerAddress = async (
  address: AddressFormProps
): Promise<string>

Parameter	Type	Req?	Description
address	AddressFormProps	Yes	The new customer address including street, city, region, country, postal code, and optional fields like company name and phone number.

Events

Does not emit any drop-in events.

Returns

Returns string.

getAdobeCommerceOptimizerData

The getAdobeCommerceOptimizerData function fetches Adobe Commerce Optimizer data.

const getAdobeCommerceOptimizerData = async (): Promise<AdobeCommerceOptimizerModel>

Events

Emits the auth/adobe-commerce-optimizer event.

Returns

Returns AdobeCommerceOptimizerModel.

getAttributesForm

The getAttributesForm function retrieves entity-attribute-value (EAV) attributes associated with customer and customer address frontend forms. The function calls the attributesForm query .

const getAttributesForm = async (
  formCode: string
): Promise<AttributesFormModel[]>

Parameter	Type	Req?	Description
formCode	string	Yes	The form code, one of: customer_account_create, customer_account_edit, customer_address_create, or customer_address_edit.

Events

Does not emit any drop-in events.

Returns

Returns AttributesFormModel[].

getCustomerData

The getCustomerData function retrieves data about the customer represented by the value of the auth_dropin_user_token cookie. The function calls the customer query .

const getCustomerData = async (
  user_token: string
): Promise<CustomerModel>

Parameter	Type	Req?	Description
user_token	string	Yes	The customer authentication token from the auth_dropin_user_token cookie.

Events

Does not emit any drop-in events.

Returns

Returns CustomerModel.

getCustomerRolePermissions

The getCustomerRolePermissions function retrieves customer role permissions. It caches results to minimize API calls, returning cached data immediately when available or fetching fresh data when the cache is empty.

const getCustomerRolePermissions = async (): Promise<PermissionsModel>

Events

Emits the auth/permissions event.

Returns

Returns PermissionsModel.

getCustomerToken

The getCustomerToken function handles the sign-in operation. It requires email and password (and accepts additional optional properties on the parameter object) and performs these actions:

1. Retrieves the customer token.
2. Fetches customer data using the token.
3. Sets the auth_dropin_firstname and auth_dropin_user_token cookies.
4. Publishes an Adobe Client Data Layer (ACDL) event.
5. Emits an “authenticated” event.

You can use the getCustomerToken function to build a custom authentication flow that remains fully integrated with other drop-in components. The function calls the generateCustomerToken mutation .

const getCustomerToken = async (
  { email, password, translations, onErrorCallback, handleSetInLineAlertProps, }: getCustomerTokenProps
): Promise<{
  errorMessage: string;
  userName: string;
  userEmail: string;
}>

Parameter	Type	Req?	Description
email	string	Yes	The customer’s email address (or username, depending on store configuration).
password	string	Yes	The customer’s password.

Additional optional properties on the same object may include translations, onErrorCallback, and handleSetInLineAlertProps. See getCustomerTokenProps in the drop-in source for the full type.

Events

Does not emit any drop-in events.

Returns

Promise<{
  errorMessage: string;
  userName: string;
  userEmail: string;
}>

getStoreConfig

The getStoreConfig function calls the storeConfig query to retrieve store configuration data.

const getStoreConfig = async (): Promise<StoreConfigModel>

Events

Does not emit any drop-in events.

Returns

Returns StoreConfigModel.

requestPasswordResetEmail

The requestPasswordResetEmail function initiates the process of resetting a customer’s password. The function calls the requestPasswordResetEmail mutation .

const requestPasswordResetEmail = async (
  email: string
): Promise<PasswordResetEmailModel>

Parameter	Type	Req?	Description
email	string	Yes	The email address of the customer requesting a password reset.

Events

Does not emit any drop-in events.

Returns

Returns PasswordResetEmailModel.

resendConfirmationEmail

The resendConfirmationEmail function resends the email confirmation to the customer using the supplied customerEmail parameter. The function calls the resendConfirmationEmail mutation , which is included in the Storefront Compatibility Package.

const resendConfirmationEmail = async (
  customerEmail: string
): Promise<resendConfirmationEmailResponse>

Parameter	Type	Req?	Description
customerEmail	string	Yes	The email address of the customer who needs the confirmation email resent.

Events

Does not emit any drop-in events.

Returns

Returns resendConfirmationEmailResponse.

resetPassword

The resetPassword function resets a customer’s password using the supplied email, resetPasswordToken, and newPassword parameters. The function calls the resetPassword mutation .

const resetPassword = async (
  email: string,
  resetPasswordToken: string,
  newPassword: string
): Promise<ResetPasswordModel>

Parameter	Type	Req?	Description
email	string	Yes	The email address of the customer resetting their password.
resetPasswordToken	string	Yes	The password reset token sent to the customer’s email.
newPassword	string	Yes	The new password for the customer account.

Events

Does not emit any drop-in events.

Returns

Returns ResetPasswordModel.

revokeCustomerToken

The revokeCustomerToken function revokes the customer’s token and clears the authentication cookie. It then publishes an ACDL event and emits an “authenticated” event. Use this function to build a custom sign-out flow that stays fully integrated with other drop-in components. The function calls the revokeCustomerToken mutation .

const revokeCustomerToken = async (): Promise<RevokeCustomerTokenModel>

Events

Does not emit any drop-in events.

Returns

Returns RevokeCustomerTokenModel.

verifyToken

The verifyToken function checks the validity of the stored customer token. If valid, it emits the authenticated event with true. If the token is invalid or missing, it clears the authentication cookies and header, and emits authenticated with false.

By default, the validation query is compatible with all backends. When adobeCommerceOptimizer is set to true, the function also emits the auth/group-uid event required for Adobe Commerce Optimizer price book resolution.

const verifyToken = async (
  authType = 'Authorization',
  type = 'Bearer',
  adobeCommerceOptimizer = false
): Promise<boolean>

Parameter	Type	Req?	Description
authType	string	No	The name of the HTTP authorization header. Defaults to Authorization.
type	string	No	The credential type prefixed to the token in the authorization header (for example, Bearer <token>). Defaults to Bearer.
adobeCommerceOptimizer	boolean	No	When true, emits the auth/group-uid event for Adobe Commerce Optimizer price book resolution. Defaults to false.

Events

Emits the authenticated event.

When adobeCommerceOptimizer is true, also emits the auth/group-uid event.

Returns

Returns Promise<boolean>. Returns true if the token is valid, false otherwise.

Data Models

Functions in this drop-in use the following data models.

AdobeCommerceOptimizerModel

The AdobeCommerceOptimizerModel object is returned by the following functions: getAdobeCommerceOptimizerData.

interface AdobeCommerceOptimizerModel {
  priceBookId: string;
}

CustomerModel

The CustomerModel object is returned by the following functions: createCustomer, getCustomerData.

interface CustomerModel {
  firstName: string;
  lastName: string;
  email: string;
  groupUid: string;
  customAttributes?: Record<string, string>[];
  errors?: { message: string }[];
}

PasswordResetEmailModel

The PasswordResetEmailModel object is returned by the following functions: requestPasswordResetEmail.

interface PasswordResetEmailModel {
  message: string | '';
  success: boolean;
}

PermissionsModel

The PermissionsModel object is returned by the following functions: getCustomerRolePermissions.

interface PermissionsModel {
  all?: boolean;
  admin?: boolean;
  [key: string]: boolean;
}

ResetPasswordModel

The ResetPasswordModel object is returned by the following functions: resetPassword.

interface ResetPasswordModel {
  message: string | '';
  success: boolean;
}

RevokeCustomerTokenModel

The RevokeCustomerTokenModel object is returned by the following functions: revokeCustomerToken.

interface RevokeCustomerTokenModel {
  message: string | '';
  success: boolean;
}

StoreConfigModel

The StoreConfigModel object is returned by the following functions: getStoreConfig.

interface StoreConfigModel {
  autocompleteOnStorefront: boolean;
  minLength: number;
  requiredCharacterClasses: number;
  createAccountConfirmation: boolean;
  customerAccessTokenLifetime: number;
}