Alokai

OAuthUserAuthenticationProps

Properties for user authentication.

interface OAuthUserAuthenticationProps {
	additionalParams?: Record<string, string>;
	password: string;
	username: string;
}

Properties

NameRequiredTypeDescription
additionalParamsOptionalRecord<string, string>Extra parameters forwarded to the SAP Commerce Cloud login request, e.g. a CAPTCHA response token expected by a server-side customization. With PKCE enabled they are sent as form fields of the authorization server login request; with the ROPC flow they are sent as parameters of the token request. Parameters used by the OAuth flow itself (credentials, CSRF and client fields) cannot be overridden.
passwordRequiredstringUser password.
usernameRequiredstringUnique identifier of a user (e.g an email address). Value provided for the uid field during the sign-up.

On this page