Class ShopperLogin<ConfigParameters>

Shopper Login

*# API Overview

The Shopper Login and API Access Service (SLAS) enables secure access to Commerce Cloud’s Shopper APIs for a wide range of headless commerce applications.

Important:* Before using this API, see Authorization for Shopper APIs in the Get Started guides and the more detailed SLAS guides for instructions on setting up a SLAS client, obtaining credentials, as well as flow and use case information.

For load shedding and rate limiting information, see Load Shedding and Rate Limiting.*

Simple example:

  import { ShopperLogin } from "commerce-sdk-isomorphic";

  const clientConfig = {
    parameters: {
      clientId: "XXXXXX",
      organizationId: "XXXX",
      shortCode: "XXX",
      siteId: "XX"
    }
  };
  const shopperLoginClient = new ShopperLogin(clientConfig);

API Version: 0.0.33
Last Updated:

Type Parameters

ConfigParameters extends ShopperLoginParameters & Record<string, unknown>

Hierarchy

ShopperLogin

Constructors

constructor

new ShopperLogin<ConfigParameters>(config): ShopperLogin<ConfigParameters>
Type Parameters
- ConfigParameters extends Partial<authenticateCustomerPathParameters & authorizeCustomerPathParameters & authorizePasswordlessCustomerPathParameters & getAccessTokenPathParameters & getJwksUriPathParameters & getPasswordLessAccessTokenPathParameters & getPasswordResetTokenPathParameters & getSessionBridgeAccessTokenPathParameters & getTrustedAgentAccessTokenPathParameters & getTrustedAgentAuthorizationTokenPathParameters & getTrustedSystemAccessTokenPathParameters & getUserInfoPathParameters & getWellknownOpenidConfigurationPathParameters & introspectTokenPathParameters & logoutCustomerPathParameters & resetPasswordPathParameters$0 & revokeTokenPathParameters> & BaseUriParameters & Partial<authorizeCustomerQueryParameters & getTrustedAgentAuthorizationTokenQueryParameters & getUserInfoQueryParameters & logoutCustomerQueryParameters> & Record<string, unknown>
Parameters
- config: ClientConfigInit<ConfigParameters>
Returns ShopperLogin<ConfigParameters>
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:36882

Methods

authenticateCustomer

authenticateCustomer(options?): Promise<void>
This follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).

For PKCE values:
- The code_verifier string is a random string used for the /token endpoint request.
- The code_challenge is an encoded version of the code_verifier string using an SHA-256 hash.
The request must include a basic authorization header that contains a Base64 encoded version of the following string: <shopperUserID>:<shopperPassword>. Required parameters: code_challenge, channel_id, client_id, and redirect_uri.

Optional parameters: usid. The SLAS /login endpoint redirects back to the redirect URI and returns an authorization code. Calls to /login made with the same loginId and tenantId within 1 second result in a conflict.

If you would like to get a raw Response object use the other authenticateCustomer function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: authenticateCustomerBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<void>
A promise of type void.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37166
authenticateCustomer<T>(options?, rawResponse?): Promise<T extends true
? Response
: void>
This follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).

For PKCE values:
- The code_verifier string is a random string used for the /token endpoint request.
- The code_challenge is an encoded version of the code_verifier string using an SHA-256 hash.
The request must include a basic authorization header that contains a Base64 encoded version of the following string: <shopperUserID>:<shopperPassword>. Required parameters: code_challenge, channel_id, client_id, and redirect_uri.

Optional parameters: usid. The SLAS /login endpoint redirects back to the redirect URI and returns an authorization code. Calls to /login made with the same loginId and tenantId within 1 second result in a conflict.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: authenticateCustomerBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: void>
A promise of type Response if rawResponse is true, a promise of type void otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37206

authorizeCustomer

authorizeCustomer(options?): Promise<void>
This is the first step of the OAuth 2.1 authorization code flow, in which a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.

You can call this endpoint from the front channel (the browser).

If you would like to get a raw Response object use the other authorizeCustomer function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id?: string;
              client_id: string;
              code_challenge?: string;
              hint?: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
              scope?: AuthorizeCustomerScopeEnum;
              state?: string;
              ui_locales?: string;
              usid?: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id?: string;
              client_id: string;
              code_challenge?: string;
              hint?: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
              scope?: AuthorizeCustomerScopeEnum;
              state?: string;
              ui_locales?: string;
              usid?: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<void>
A promise of type void.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37256
authorizeCustomer<T>(options?, rawResponse?): Promise<T extends true
? Response
: void>
This is the first step of the OAuth 2.1 authorization code flow, in which a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.

You can call this endpoint from the front channel (the browser).
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id?: string;
              client_id: string;
              code_challenge?: string;
              hint?: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
              scope?: AuthorizeCustomerScopeEnum;
              state?: string;
              ui_locales?: string;
              usid?: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id?: string;
              client_id: string;
              code_challenge?: string;
              hint?: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
              scope?: AuthorizeCustomerScopeEnum;
              state?: string;
              ui_locales?: string;
              usid?: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: void>
A promise of type Response if rawResponse is true, a promise of type void otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37314

authorizePasswordlessCustomer

authorizePasswordlessCustomer(options?): Promise<string>
This endpoint allows customers to authenticate when their configured identity provider is inaccessible. It provides an alternative authentication path through passwordless login methods like email or SMS verification.

If you would like to get a raw Response object use the other authorizePasswordlessCustomer function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: authorizePasswordlessCustomerBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<string>
A promise of type string.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37351
authorizePasswordlessCustomer<T>(options?, rawResponse?): Promise<T extends true
? Response
: string>
This endpoint allows customers to authenticate when their configured identity provider is inaccessible. It provides an alternative authentication path through passwordless login methods like email or SMS verification.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: authorizePasswordlessCustomerBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: string>
A promise of type Response if rawResponse is true, a promise of type string otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37378

getAccessToken

getAccessToken(options?): Promise<TokenResponse>
This is the second step of the OAuth 2.1 authorization code flow.

For a private client, an application is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the authorize endpoint.

For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.

For a public client using PKCE, an application passes a PKCE code_verifier that matches the code_challenge that was used to authorize the customer along with the authorization code.

When refreshing the access token with a private client ID and client secret, the refresh token is not regenerated. However, when refreshing the access token with a public client ID, the refresh token is always regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client must be replaced to always store the new refresh token.

See the Body section for required parameters, including grant_type and others that depend on the value of grant_type.

Important: As of July 31, 2024*, SLAS requires the channel_id query parameter in token requests.

If you would like to get a raw Response object use the other getAccessToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenResponse>
A promise of type TokenResponse.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37421
getAccessToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenResponse>
This is the second step of the OAuth 2.1 authorization code flow.

For a private client, an application is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the authorize endpoint.

For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.

For a public client using PKCE, an application passes a PKCE code_verifier that matches the code_challenge that was used to authorize the customer along with the authorization code.

When refreshing the access token with a private client ID and client secret, the refresh token is not regenerated. However, when refreshing the access token with a public client ID, the refresh token is always regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client must be replaced to always store the new refresh token.

See the Body section for required parameters, including grant_type and others that depend on the value of grant_type.

Important: As of July 31, 2024*, SLAS requires the channel_id query parameter in token requests.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenResponse>
A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37463

getJwksUri

getJwksUri(options?): Promise<object>
The /jwks endpoint provides a JSON Web Key Set (JWKS) that includes current, past, and future public keys. These keys allow clients to validate the Shopper JSON Web Token (JWT) issued by SLAS, ensuring that no tampering with the token has occurred. Every SLAS JWT that is passed into SLAS, SCAPI, or OCAPI is always validated and is rejected if the signature validation does not match.

To optimize performance, the /jwks endpoint is limited to 25 calls per minute, so we recommended caching the JWKS keys and refresh them only when necessary, instead of making frequent requests. Typically, the JWKs endpoint can be used once per DAY.

For additional information on using JWKS, see https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-validate-jwt-with-jwks.html.

If you would like to get a raw Response object use the other getJwksUri function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<object>
A promise of type object.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37489
getJwksUri<T>(options?, rawResponse?): Promise<T extends true
? Response
: object>
The /jwks endpoint provides a JSON Web Key Set (JWKS) that includes current, past, and future public keys. These keys allow clients to validate the Shopper JSON Web Token (JWT) issued by SLAS, ensuring that no tampering with the token has occurred. Every SLAS JWT that is passed into SLAS, SCAPI, or OCAPI is always validated and is rejected if the signature validation does not match.

To optimize performance, the /jwks endpoint is limited to 25 calls per minute, so we recommended caching the JWKS keys and refresh them only when necessary, instead of making frequent requests. Typically, the JWKs endpoint can be used once per DAY.

For additional information on using JWKS, see https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-validate-jwt-with-jwks.html.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: object>
A promise of type Response if rawResponse is true, a promise of type object otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37513

getPasswordLessAccessToken

getPasswordLessAccessToken(options?): Promise<TokenResponse>
This endpoint issues a shopper JWT access token using a passwordless login token. It enables authentication flows where traditional username/password combinations are not required, supporting alternative authentication methods.

If you would like to get a raw Response object use the other getPasswordLessAccessToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getPasswordLessAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenResponse>
A promise of type TokenResponse.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37539
getPasswordLessAccessToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenResponse>
This endpoint issues a shopper JWT access token using a passwordless login token. It enables authentication flows where traditional username/password combinations are not required, supporting alternative authentication methods.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getPasswordLessAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenResponse>
A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37565

getPasswordResetToken

getPasswordResetToken(options?): Promise<void>
This endpoint initiates the password reset process for a customer by requesting a password reset token. The token is delivered through the configured delivery mode (email, SMS, etc.) and can be used with the password/action endpoint to set a new password.

If you would like to get a raw Response object use the other getPasswordResetToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getPasswordResetTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<void>
A promise of type void.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37596
getPasswordResetToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: void>
This endpoint initiates the password reset process for a customer by requesting a password reset token. The token is delivered through the configured delivery mode (email, SMS, etc.) and can be used with the password/action endpoint to set a new password.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getPasswordResetTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: void>
A promise of type Response if rawResponse is true, a promise of type void otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37626

getSessionBridgeAccessToken

getSessionBridgeAccessToken(options?): Promise<TokenResponse>
For public client ID requests, you must set the grant_type to session_bridge.

For private client_id and secret, you must set the grant_type to client_credentials along with a basic authorization header.

DEPRECATED* - As of January 31, 2024, SLAS no longer supports the SESB dwsid parameter for guest users for session-bridge/token calls. We recommended you transition to using a SESB dwsgst token.

The dwsid is still needed for registered user session-bridge/token calls.

NOTE:* The registered customer Json Web Token (JWT) is available in B2C Commerce versions 25.4 and later.

If you would like to get a raw Response object use the other getSessionBridgeAccessToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getSessionBridgeAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenResponse>
A promise of type TokenResponse.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37667
getSessionBridgeAccessToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenResponse>
For public client ID requests, you must set the grant_type to session_bridge.

For private client_id and secret, you must set the grant_type to client_credentials along with a basic authorization header.

DEPRECATED* - As of January 31, 2024, SLAS no longer supports the SESB dwsid parameter for guest users for session-bridge/token calls. We recommended you transition to using a SESB dwsgst token.

The dwsid is still needed for registered user session-bridge/token calls.

NOTE:* The registered customer Json Web Token (JWT) is available in B2C Commerce versions 25.4 and later.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getSessionBridgeAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenResponse>
A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37707

getTrustedAgentAccessToken

getTrustedAgentAccessToken(options?): Promise<TokenResponse>
If using a SLAS private client ID, you must also use an _sfdc_client_auth header.

The value of the _sfdc_client_auth header must be a Base64-encoded string. The string is composed of a SLAS private client ID and client secret, separated by a colon (:). For example, privateClientId:privateClientsecret becomes cHJpdmF0ZUNsaWVudElkOnByaXZhdGVDbGllbnRzZWNyZXQ= after Base64 encoding.

If you would like to get a raw Response object use the other getTrustedAgentAccessToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getTrustedAgentAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenResponse>
A promise of type TokenResponse.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37741
getTrustedAgentAccessToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenResponse>
If using a SLAS private client ID, you must also use an _sfdc_client_auth header.

The value of the _sfdc_client_auth header must be a Base64-encoded string. The string is composed of a SLAS private client ID and client secret, separated by a colon (:). For example, privateClientId:privateClientsecret becomes cHJpdmF0ZUNsaWVudElkOnByaXZhdGVDbGllbnRzZWNyZXQ= after Base64 encoding.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getTrustedAgentAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenResponse>
A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37774

getTrustedAgentAuthorizationToken

getTrustedAgentAuthorizationToken(options?): Promise<void>
This endpoint enables trusted agents (such as customer service representatives or merchants) to obtain authorization tokens that allow them to act on behalf of registered customers. This facilitates customer support scenarios where agents need secure access to customer accounts.

If you would like to get a raw Response object use the other getTrustedAgentAuthorizationToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id: string;
              client_id: string;
              code_challenge?: string;
              idp_origin: string;
              login_id: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id: string;
              client_id: string;
              code_challenge?: string;
              idp_origin: string;
              login_id: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<void>
A promise of type void.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37817
getTrustedAgentAuthorizationToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: void>
This endpoint enables trusted agents (such as customer service representatives or merchants) to obtain authorization tokens that allow them to act on behalf of registered customers. This facilitates customer support scenarios where agents need secure access to customer accounts.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id: string;
              client_id: string;
              code_challenge?: string;
              idp_origin: string;
              login_id: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id: string;
              client_id: string;
              code_challenge?: string;
              idp_origin: string;
              login_id: string;
              organizationId: string;
              redirect_uri: string;
              response_type: "code";
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: void>
A promise of type Response if rawResponse is true, a promise of type void otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37865

getTrustedSystemAccessToken

getTrustedSystemAccessToken(options?): Promise<TokenResponse>
The SLAS client must have the sfcc.ts_ext_on_behalf_of scope to access this endpoint.

For trusted-system requests, you can use a basic authorization header that includes a SLAS private client ID and SLAS private client secret instead of the bearer token.

For trusted-system requests, you cannot use SLAS public client_ids.

If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getTrustedSystemAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenResponse>
A promise of type TokenResponse.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37908
getTrustedSystemAccessToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenResponse>
The SLAS client must have the sfcc.ts_ext_on_behalf_of scope to access this endpoint.

For trusted-system requests, you can use a basic authorization header that includes a SLAS private client ID and SLAS private client secret instead of the bearer token.

For trusted-system requests, you cannot use SLAS public client_ids.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: getTrustedSystemAccessTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenResponse>
A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37944

getUserInfo

getUserInfo(options?): Promise<string>
This endpoint returns identity information about the authenticated user in the form of OpenID Connect claims. It requires a valid access token and returns information such as user ID, name, email, and other identity attributes based on the scopes granted during authentication.

If you would like to get a raw Response object use the other getUserInfo function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id?: string;
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id?: string;
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<string>
A promise of type string.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37966
getUserInfo<T>(options?, rawResponse?): Promise<T extends true
? Response
: string>
This endpoint returns identity information about the authenticated user in the form of OpenID Connect claims. It requires a valid access token and returns information such as user ID, name, email, and other identity attributes based on the scopes granted during authentication.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id?: string;
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id?: string;
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: string>
A promise of type Response if rawResponse is true, a promise of type string otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:37987

getWellknownOpenidConfiguration

getWellknownOpenidConfiguration(options?): Promise<string>
This endpoint provides OpenID Connect discovery information in a standardized format. It allows clients to programmatically discover SLAS capabilities, including available endpoints, supported authentication flows, token signing algorithms, and other configuration details. This information helps clients integrate with the authentication service with minimal manual configuration.

If you would like to get a raw Response object use the other getWellknownOpenidConfiguration function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<string>
A promise of type string.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38008
getWellknownOpenidConfiguration<T>(options?, rawResponse?): Promise<T extends true
? Response
: string>
This endpoint provides OpenID Connect discovery information in a standardized format. It allows clients to programmatically discover SLAS capabilities, including available endpoints, supported authentication flows, token signing algorithms, and other configuration details. This information helps clients integrate with the authentication service with minimal manual configuration.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: string>
A promise of type Response if rawResponse is true, a promise of type string otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38027

introspectToken

introspectToken(options?): Promise<TokenActionRequest>
A basic auth header with Base64-encoded clientId:secret is required in the Authorization header, as well as an access token or refresh token. Use token_type_hint to help identify the token.

If you would like to get a raw Response object use the other introspectToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: introspectTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenActionRequest>
A promise of type TokenActionRequest.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38050
introspectToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenActionRequest>
A basic auth header with Base64-encoded clientId:secret is required in the Authorization header, as well as an access token or refresh token. Use token_type_hint to help identify the token.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: introspectTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenActionRequest>
A promise of type Response if rawResponse is true, a promise of type TokenActionRequest otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38073

logoutCustomer

logoutCustomer(options?): Promise<TokenResponse>
The shopper's access token and refresh token are revoked. If the shopper authenticated with a B2C Commerce (B2C Commerce) instance, the OCAPI JWT is also revoked. Call this endpoint for registered users that have logged in using SLAS. Do not use this endpoint for guest users.

Required header: Authorization header bearer token of the Shopper access token to log out.

Required parameters: refresh token, channel_id, and client.

If you would like to get a raw Response object use the other logoutCustomer function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id?: string;
              client_id: string;
              hint?: "all-sessions";
              organizationId: string;
              refresh_token: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id?: string;
              client_id: string;
              hint?: "all-sessions";
              organizationId: string;
              refresh_token: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenResponse>
A promise of type TokenResponse.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38106
logoutCustomer<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenResponse>
The shopper's access token and refresh token are revoked. If the shopper authenticated with a B2C Commerce (B2C Commerce) instance, the OCAPI JWT is also revoked. Call this endpoint for registered users that have logged in using SLAS. Do not use this endpoint for guest users.

Required header: Authorization header bearer token of the Shopper access token to log out.

Required parameters: refresh token, channel_id, and client.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              channel_id?: string;
              client_id: string;
              hint?: "all-sessions";
              organizationId: string;
              refresh_token: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              channel_id?: string;
              client_id: string;
              hint?: "all-sessions";
              organizationId: string;
              refresh_token: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenResponse>
A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38141

resetPassword

resetPassword(options?): Promise<void>
This endpoint allows a customer to set a new password using a valid password reset token. The customer must provide the token received from the password/reset endpoint along with the desired new password.

If you would like to get a raw Response object use the other resetPassword function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: resetPasswordBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<void>
A promise of type void.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38172
resetPassword<T>(options?, rawResponse?): Promise<T extends true
? Response
: void>
This endpoint allows a customer to set a new password using a valid password reset token. The customer must provide the token received from the password/reset endpoint along with the desired new password.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: resetPasswordBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: void>
A promise of type Response if rawResponse is true, a promise of type void otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38199

revokeToken

revokeToken(options?): Promise<TokenActionRequest>
A basic auth header with Base64-encoded clientId:secret is required in the Authorization header, and the refresh token to be revoked is required in the body.

If you would like to get a raw Response object use the other revokeToken function.
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: revokeTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
Returns Promise<TokenActionRequest>
A promise of type TokenActionRequest.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38223
revokeToken<T>(options?, rawResponse?): Promise<T extends true
? Response
: TokenActionRequest>
A basic auth header with Base64-encoded clientId:secret is required in the Authorization header, and the refresh token to be revoked is required in the body.
Type Parameters
- T extends boolean
Parameters
- Optional options: RequireParametersUnlessAllAreOptional<{
      body: revokeTokenBodyType & CustomRequestBody;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          [K in string | number]: (Omit<{
              organizationId: string;
          } & QueryParameters, keyof ConfigParameters> & Partial<{
              organizationId: string;
          } & QueryParameters>)[K]
      };
  }>
  
  An object containing the options for this method.
- Optional rawResponse: T
  
  Set to true to return entire Response object instead of DTO.
Returns Promise<T extends true
? Response
: TokenActionRequest>
A promise of type Response if rawResponse is true, a promise of type TokenActionRequest otherwise.
- Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:38246

Properties

clientConfig

clientConfig: ClientConfig<ConfigParameters> & {
baseUri: string;
}

Type declaration

baseUri: string

`Static` `Readonly` apiPaths

apiPaths: {
    authenticateCustomer: string;
    authorizeCustomer: string;
    authorizePasswordlessCustomer: string;
    getAccessToken: string;
    getJwksUri: string;
    getPasswordLessAccessToken: string;
    getPasswordResetToken: string;
    getSessionBridgeAccessToken: string;
    getTrustedAgentAccessToken: string;
    getTrustedAgentAuthorizationToken: string;
    getTrustedSystemAccessToken: string;
    getUserInfo: string;
    getWellknownOpenidConfiguration: string;
    introspectToken: string;
    logoutCustomer: string;
    resetPassword: string;
    revokeToken: string;
}

Type declaration

authenticateCustomer: string
authorizeCustomer: string
authorizePasswordlessCustomer: string
getAccessToken: string
getJwksUri: string
getPasswordLessAccessToken: string
getPasswordResetToken: string
getSessionBridgeAccessToken: string
getTrustedAgentAccessToken: string
getTrustedAgentAuthorizationToken: string
getTrustedSystemAccessToken: string
getUserInfo: string
getWellknownOpenidConfiguration: string
introspectToken: string
logoutCustomer: string
resetPassword: string
revokeToken: string

`Static` `Readonly` defaultBaseUri

defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1"

`Static` `Readonly` paramKeys

paramKeys: {
    authenticateCustomer: readonly ["organizationId", "redirect_uri", "channel_id", "client_id", "response_type", "state", "scope", "usid", "code_challenge"];
    authenticateCustomerRequired: readonly ["organizationId", "redirect_uri", "channel_id"];
    authorizeCustomer: readonly ["organizationId", "redirect_uri", "response_type", "client_id", "scope", "state", "usid", "hint", "channel_id", "code_challenge", "ui_locales"];
    authorizeCustomerRequired: readonly ["organizationId", "redirect_uri", "response_type", "client_id"];
    authorizePasswordlessCustomer: readonly ["organizationId", "user_id", "mode", "channel_id", "locale", "usid", "callback_uri"];
    authorizePasswordlessCustomerRequired: readonly ["organizationId", "user_id", "mode", "channel_id"];
    getAccessToken: readonly ["organizationId", "grant_type", "refresh_token", "code", "usid", "redirect_uri", "code_verifier", "client_id", "channel_id", "dnt"];
    getAccessTokenRequired: readonly ["organizationId", "grant_type"];
    getJwksUri: readonly ["organizationId"];
    getJwksUriRequired: readonly ["organizationId"];
    getPasswordLessAccessToken: readonly ["organizationId", "grant_type", "hint", "pwdless_login_token", "client_id", "code_verifier"];
    getPasswordLessAccessTokenRequired: readonly ["organizationId", "grant_type", "hint", "pwdless_login_token"];
    getPasswordResetToken: readonly ["organizationId", "user_id", "mode", "channel_id", "locale", "client_id", "code_challenge", "callback_uri", "idp_name", "hint"];
    getPasswordResetTokenRequired: readonly ["organizationId", "user_id", "mode", "channel_id"];
    getSessionBridgeAccessToken: readonly ["organizationId", "code", "client_id", "channel_id", "code_verifier", "dwsid", "grant_type", "login_id", "dwsgst", "dwsrst", "usid", "dnt"];
    getSessionBridgeAccessTokenRequired: readonly ["organizationId", "code", "client_id", "channel_id", "code_verifier", "dwsid", "grant_type", "login_id"];
    getTrustedAgentAccessToken: readonly ["organizationId", "client_id", "channel_id", "code_verifier", "grant_type", "login_id", "idp_origin", "agent_id", "usid", "dnt", "state"];
    getTrustedAgentAccessTokenRequired: readonly ["organizationId", "client_id", "channel_id", "code_verifier", "grant_type", "login_id", "idp_origin"];
    getTrustedAgentAuthorizationToken: readonly ["organizationId", "client_id", "channel_id", "login_id", "idp_origin", "redirect_uri", "response_type", "code_challenge"];
    getTrustedAgentAuthorizationTokenRequired: readonly ["organizationId", "client_id", "channel_id", "login_id", "idp_origin", "redirect_uri", "response_type"];
    getTrustedSystemAccessToken: readonly ["organizationId", "grant_type", "hint", "login_id", "idp_origin", "client_id", "channel_id", "usid", "email_id", "dnt"];
    getTrustedSystemAccessTokenRequired: readonly ["organizationId", "grant_type", "hint", "login_id", "idp_origin", "client_id", "channel_id"];
    getUserInfo: readonly ["organizationId", "channel_id"];
    getUserInfoRequired: readonly ["organizationId"];
    getWellknownOpenidConfiguration: readonly ["organizationId"];
    getWellknownOpenidConfigurationRequired: readonly ["organizationId"];
    introspectToken: readonly ["organizationId", "token", "token_type_hint"];
    introspectTokenRequired: readonly ["organizationId", "token"];
    logoutCustomer: readonly ["organizationId", "client_id", "refresh_token", "channel_id", "hint"];
    logoutCustomerRequired: readonly ["organizationId", "client_id", "refresh_token"];
    resetPassword: readonly ["organizationId", "client_id", "pwd_action_token", "code_verifier", "channel_id", "new_password", "hint"];
    resetPasswordRequired: readonly ["organizationId", "client_id", "pwd_action_token", "code_verifier", "channel_id"];
    revokeToken: readonly ["organizationId", "token", "token_type_hint"];
    revokeTokenRequired: readonly ["organizationId", "token"];
}

Type declaration

Readonly authenticateCustomer: readonly ["organizationId", "redirect_uri", "channel_id", "client_id", "response_type", "state", "scope", "usid", "code_challenge"]
Readonly authenticateCustomerRequired: readonly ["organizationId", "redirect_uri", "channel_id"]
Readonly authorizeCustomer: readonly ["organizationId", "redirect_uri", "response_type", "client_id", "scope", "state", "usid", "hint", "channel_id", "code_challenge", "ui_locales"]
Readonly authorizeCustomerRequired: readonly ["organizationId", "redirect_uri", "response_type", "client_id"]
Readonly authorizePasswordlessCustomer: readonly ["organizationId", "user_id", "mode", "channel_id", "locale", "usid", "callback_uri"]
Readonly authorizePasswordlessCustomerRequired: readonly ["organizationId", "user_id", "mode", "channel_id"]
Readonly getAccessToken: readonly ["organizationId", "grant_type", "refresh_token", "code", "usid", "redirect_uri", "code_verifier", "client_id", "channel_id", "dnt"]
Readonly getAccessTokenRequired: readonly ["organizationId", "grant_type"]
Readonly getJwksUri: readonly ["organizationId"]
Readonly getJwksUriRequired: readonly ["organizationId"]
Readonly getPasswordLessAccessToken: readonly ["organizationId", "grant_type", "hint", "pwdless_login_token", "client_id", "code_verifier"]
Readonly getPasswordLessAccessTokenRequired: readonly ["organizationId", "grant_type", "hint", "pwdless_login_token"]
Readonly getPasswordResetToken: readonly ["organizationId", "user_id", "mode", "channel_id", "locale", "client_id", "code_challenge", "callback_uri", "idp_name", "hint"]
Readonly getPasswordResetTokenRequired: readonly ["organizationId", "user_id", "mode", "channel_id"]
Readonly getSessionBridgeAccessToken: readonly ["organizationId", "code", "client_id", "channel_id", "code_verifier", "dwsid", "grant_type", "login_id", "dwsgst", "dwsrst", "usid", "dnt"]
Readonly getSessionBridgeAccessTokenRequired: readonly ["organizationId", "code", "client_id", "channel_id", "code_verifier", "dwsid", "grant_type", "login_id"]
Readonly getTrustedAgentAccessToken: readonly ["organizationId", "client_id", "channel_id", "code_verifier", "grant_type", "login_id", "idp_origin", "agent_id", "usid", "dnt", "state"]
Readonly getTrustedAgentAccessTokenRequired: readonly ["organizationId", "client_id", "channel_id", "code_verifier", "grant_type", "login_id", "idp_origin"]
Readonly getTrustedAgentAuthorizationToken: readonly ["organizationId", "client_id", "channel_id", "login_id", "idp_origin", "redirect_uri", "response_type", "code_challenge"]
Readonly getTrustedAgentAuthorizationTokenRequired: readonly ["organizationId", "client_id", "channel_id", "login_id", "idp_origin", "redirect_uri", "response_type"]
Readonly getTrustedSystemAccessToken: readonly ["organizationId", "grant_type", "hint", "login_id", "idp_origin", "client_id", "channel_id", "usid", "email_id", "dnt"]
Readonly getTrustedSystemAccessTokenRequired: readonly ["organizationId", "grant_type", "hint", "login_id", "idp_origin", "client_id", "channel_id"]
Readonly getUserInfo: readonly ["organizationId", "channel_id"]
Readonly getUserInfoRequired: readonly ["organizationId"]
Readonly getWellknownOpenidConfiguration: readonly ["organizationId"]
Readonly getWellknownOpenidConfigurationRequired: readonly ["organizationId"]
Readonly introspectToken: readonly ["organizationId", "token", "token_type_hint"]
Readonly introspectTokenRequired: readonly ["organizationId", "token"]
Readonly logoutCustomer: readonly ["organizationId", "client_id", "refresh_token", "channel_id", "hint"]
Readonly logoutCustomerRequired: readonly ["organizationId", "client_id", "refresh_token"]
Readonly resetPassword: readonly ["organizationId", "client_id", "pwd_action_token", "code_verifier", "channel_id", "new_password", "hint"]
Readonly resetPasswordRequired: readonly ["organizationId", "client_id", "pwd_action_token", "code_verifier", "channel_id"]
Readonly revokeToken: readonly ["organizationId", "token", "token_type_hint"]
Readonly revokeTokenRequired: readonly ["organizationId", "token"]

Class ShopperLogin<ConfigParameters>

Shopper Login

Type Parameters

ConfigParameters extends ShopperLoginParameters & Record<string, unknown>

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Type Parameters

Parameters

config: ClientConfigInit<ConfigParameters>

Returns ShopperLogin<ConfigParameters>

Methods

authenticateCustomer

Parameters

Returns Promise<void>

Type Parameters

T extends boolean

Parameters

Optional rawResponse: T

Returns Promise<T extends true ? Response : void>

authorizeCustomer

Parameters

Returns Promise<void>

Type Parameters

T extends boolean

Parameters

Optional rawResponse: T

Returns Promise<T extends true ? Response : void>

authorizePasswordlessCustomer

Parameters

Returns Promise<string>

Type Parameters

T extends boolean

Parameters

Optional rawResponse: T

Returns Promise<T extends true ? Response : string>

getAccessToken

Parameters

Returns Promise<TokenResponse>

Type Parameters

T extends boolean

Parameters

Optional rawResponse: T

Returns Promise<T extends true ? Response : TokenResponse>

getJwksUri

Parameters

Optional options: RequireParametersUnlessAllAreOptional<{ headers?: { [key: string]: string; }; parameters?: { [K in string | number]: (Omit<{ organizationId: string; } & QueryParameters, keyof ConfigParameters> & Partial<{ organizationId: string; } & QueryParameters>)[K] }; }>

Returns Promise<object>

Type Parameters

T extends boolean

Parameters

Optional options: RequireParametersUnlessAllAreOptional<{ headers?: { [key: string]: string; }; parameters?: { [K in string | number]: (Omit<{ organizationId: string; } & QueryParameters, keyof ConfigParameters> & Partial<{ organizationId: string; } & QueryParameters>)[K] }; }>

Optional rawResponse: T

Returns Promise<T extends true ? Response : object>

getPasswordLessAccessToken

Parameters

Returns Promise<TokenResponse>

Type Parameters

T extends boolean

Parameters

Optional rawResponse: T

Returns Promise<T extends true ? Response : TokenResponse>

getPasswordResetToken

Parameters

Returns Promise<void>

Type Parameters

T extends boolean

Parameters

Optional rawResponse: T

Returns Promise<T extends true ? Response : void>

getSessionBridgeAccessToken

Parameters

Returns Promise<TokenResponse>

Type Parameters

T extends boolean

Parameters

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: void>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: void>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: string>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: TokenResponse>

`Optional` options: RequireParametersUnlessAllAreOptional<{
headers?: {
[key: string]: string;
};
parameters?: {
[K in string | number]: (Omit<{
organizationId: string;
} & QueryParameters, keyof ConfigParameters> & Partial<{
organizationId: string;
} & QueryParameters>)[K]
};
}>

`Optional` options: RequireParametersUnlessAllAreOptional<{
headers?: {
[key: string]: string;
};
parameters?: {
[K in string | number]: (Omit<{
organizationId: string;
} & QueryParameters, keyof ConfigParameters> & Partial<{
organizationId: string;
} & QueryParameters>)[K]
};
}>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: object>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: TokenResponse>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: void>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: TokenResponse>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: TokenResponse>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: void>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: TokenResponse>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: string>

`Optional` options: RequireParametersUnlessAllAreOptional<{
headers?: {
[key: string]: string;
};
parameters?: {
[K in string | number]: (Omit<{
organizationId: string;
} & QueryParameters, keyof ConfigParameters> & Partial<{
organizationId: string;
} & QueryParameters>)[K]
};
}>

`Optional` options: RequireParametersUnlessAllAreOptional<{
headers?: {
[key: string]: string;
};
parameters?: {
[K in string | number]: (Omit<{
organizationId: string;
} & QueryParameters, keyof ConfigParameters> & Partial<{
organizationId: string;
} & QueryParameters>)[K]
};
}>

`Optional` rawResponse: T

Returns Promise<T extends true
? Response
: string>