Authentication types

The types the authentication domain defines, with the fields other domains add to them.

Objects

AuthenticationError

Implements Error

Field	Type	Description
code	AuthenticationErrorCodeType!	Error code indicating the type of authentication failure
message	String!	Human readable error message describing the authentication failure. Not intended for end users.

CartMerge

What signing in did with the session's guest cart.

Field	Type	Description
merged	Boolean!	Whether the guest cart's items were added to a cart the customer had saved. False when the guest cart simply became the customer's.
addedQuantity	Int!	How many items the saved cart brought in on top of the guest cart's, counted by quantity. 0 when nothing was merged.
undoable	Boolean!	Whether cartMergeUndo can restore the guest cart.

CartMergeUndoResponse

Response for undoing the cart merge of a sign-in

Field	Type	Description
success	Boolean!	Whether the guest cart was restored. It is then the current cart, so refetch the cart query.
cartErrors	[CartMergeUndoError!]	Error details if the merge could not be undone

CreateGuestSessionResponse

Response type for creating a guest session

Field	Type	Description
success	Boolean!	Whether the guest session was created successfully

CustomerLoginResponse

Field	Type	Description
customer	Customer	Authenticated customer account information
cartMerge	CartMerge	What signing in did with the session's guest cart. Null when the session had none.
customerErrors	[CustomerLoginError!]	Error details if authentication failed

CustomerLogoutResponse

Field	Type	Description
success	Boolean!	Whether the session was terminated
customerErrors	[CustomerLogoutError!]	Error details if logout failed

CustomerPasswordResetRequestResponse

Field	Type	Description
success	Boolean!	Indicates if the password reset request was successful
customerErrors	[CustomerPasswordResetRequestError!]	Error details if the request failed

CustomerPasswordResetResponse

Field	Type	Description
customer	Customer	Updated customer account information after password reset
customerErrors	[CustomerPasswordResetError!]	Error details if the password reset failed

CustomerPasswordUpdateResponse

Field	Type	Description
customer	Customer	Updated customer account information after password reset
customerErrors	[CustomerPasswordUpdateError!]	Error details if the password update failed

PasswordChangeError

Implements Error

Field	Type	Description
code	PasswordChangeErrorCodeType!	Error code indicating the specific password change failure
message	String!	Human readable error message describing the password change failure. Not intended for end users.

PasswordResetError

Implements Error

Field	Type	Description
code	PasswordResetErrorCodeType!	Error code indicating the specific password reset failure
message	String!	Human readable error message describing the password reset failure. Not intended for end users.

RefreshTokenResponse

Field	Type	Description
success	Boolean!	Indicates if the token refresh was successful
customerErrors	[RefreshTokenError!]	Error details if token refresh failed

Enums

AuthenticationErrorCodeType

INVALID_CREDENTIALS	Invalid credentials provided
ACCOUNT_INACTIVE	Account is inactive or blocked

PasswordChangeErrorCodeType

INVALID_CURRENT_PASSWORD	The current password provided is incorrect
PASSWORDS_CANT_MATCH	The new password is the same as the current password

PasswordResetErrorCodeType

INVALID_TOKEN	The password reset token is invalid or expired
TOKEN_NOT_FOUND	The password reset token was not found

Unions

CartMergeUndoError

Error union for undoing a cart merge

One of ValidationError or CartError.

CustomerLoginError

One of AuthenticationError or ValidationError.

CustomerLogoutError

One of ValidationError.

CustomerPasswordResetError

One of PasswordResetError or ValidationError.

CustomerPasswordResetRequestError

One of ValidationError.

CustomerPasswordUpdateError

One of PasswordChangeError or ValidationError.

RefreshTokenError

One of ValidationError.