validateCredentials

Validates customers' credentials.

This method sends a POST request to the validateCredentials endpoint of the Vue Storefront API Middleware. In turn, it performs the SSO login as per the validateCredentials documentation.

Signature

declare function validateCredentials(
	props: ValidateCredentialsParameter,
	options?: MethodOptions
): Promise<ValidateCredentialsResponse>;

Parameters

Name	Required	Type	Description
`props`	Required	`ValidateCredentialsParameter`	Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.
`options`	Optional	`MethodOptions`

Returns

Returns a response indicating if the credentials are valid

Referenced Types

ValidateCredentialsParameter
ValidateCredentialsResponse

Examples

Verifying the credentials

import { sdk } from '~/sdk.config.ts';

const validateCredentialsResponse = await sdk.bigcommerce.validateCredentials({ email: 'test@test.com', password: 'pa55w0rd'  });