shopperLogin

AuthenticateFinishRequest: { channel_id: string; client_id: string; credential: PublicKeyCredentialJson; email?: undefined | string; tenant_id?: undefined | string; user_id?: undefined | string; usid?: undefined | string } & {}

property

user_id: The ID of the user.

Max Length: 128

property

channel_id: The ID of the channel.

Max Length: 100

property

client_id: The ID of the OAuth client.

Min Length: 36
Max Length: 36

property

email: User's email address.

Max Length: 128

property

tenant_id: The ID of the tenant.

Max Length: 8

property

usid: The unique session ID.

Max Length: 128

property

credential:

AuthenticateResult

AuthenticateResult: { credentialId?: undefined | string; success?: undefined | false | true; tokenResponse?: TokenResponse; username?: undefined | string } & {}

property

credentialId: The credential ID that was used for authentication.

Max Length: 1024

property

username: The authenticated username.

Max Length: 128

property

success: Specifies whether authentication was successful (true) or not (false).

property

tokenResponse:

AuthenticatorAssertionResponseJson

AuthenticatorAssertionResponseJson: { authenticatorData: Array<AuthenticatorAssertionResponseJsonAuthenticatorDataInner>; clientDataJSON: Array<AuthenticatorAssertionResponseJsonClientDataJSONInner>; signature: Array<AuthenticatorAssertionResponseJsonSignatureInner>; userHandle?: Array<AuthenticatorAssertionResponseJsonUserHandleInner> | null } & {}

property: authenticatorData: Base64url-encoded authenticator data
property: clientDataJSON: Base64url-encoded client data JSON.
property: signature: Base64url-encoded signature.
property: userHandle: Base64url-encoded user handle.

AuthenticatorAssertionResponseJsonAuthenticatorDataInner

AuthenticatorAssertionResponseJsonAuthenticatorDataInner: { id?: undefined | string } & {}

property: id:

AuthenticatorAssertionResponseJsonClientDataJSONInner

AuthenticatorAssertionResponseJsonClientDataJSONInner: { id?: undefined | string } & {}

property: id:

AuthenticatorAssertionResponseJsonSignatureInner

AuthenticatorAssertionResponseJsonSignatureInner: { id?: undefined | string } & {}

property: id:

AuthenticatorAssertionResponseJsonUserHandleInner

AuthenticatorAssertionResponseJsonUserHandleInner: { id?: undefined | string } & {}

property: id:

AuthenticatorAttestationResponseJson

AuthenticatorAttestationResponseJson: { attestationObject: Array<AuthenticatorAttestationResponseJsonAttestationObjectInner>; clientDataJSON: Array<AuthenticatorAttestationResponseJsonClientDataJSONInner> } & {}

property: clientDataJSON: Base64url-encoded client data JSON.
property: attestationObject: Base64url-encoded attestation object.

AuthenticatorAttestationResponseJsonAttestationObjectInner

AuthenticatorAttestationResponseJsonAttestationObjectInner: { id?: undefined | string } & {}

property: id:

AuthenticatorAttestationResponseJsonClientDataJSONInner

AuthenticatorAttestationResponseJsonClientDataJSONInner: { id?: undefined | string } & {}

property: id:

AuthorizeCustomerResponseTypeEnum

AuthorizeCustomerResponseTypeEnum: "code"

AuthorizeCustomerScopeEnum

AuthorizeCustomerScopeEnum: "openid" | "offline_access" | "email"

AuthorizePasswordlessCustomerModeEnum

AuthorizePasswordlessCustomerModeEnum: "callback" | "sms" | "email"

AuthorizeWebauthnRegistrationModeEnum

AuthorizeWebauthnRegistrationModeEnum: "callback" | "sms" | "email"

GetPasswordLessAccessTokenGrantTypeEnum

GetPasswordLessAccessTokenGrantTypeEnum: "authorization_code" | "refresh_token" | "client_credentials" | "authorization_code_pkce" | "session_bridge"

GetPasswordResetTokenModeEnum

GetPasswordResetTokenModeEnum: "callback" | "sms" | "email"

GetSessionBridgeAccessTokenGrantTypeEnum

GetSessionBridgeAccessTokenGrantTypeEnum: "authorization_code" | "refresh_token" | "client_credentials" | "authorization_code_pkce" | "session_bridge"

GetTrustedAgentAccessTokenGrantTypeEnum

GetTrustedAgentAccessTokenGrantTypeEnum: "authorization_code" | "refresh_token" | "client_credentials" | "authorization_code_pkce" | "session_bridge"

GetTrustedAgentAuthorizationTokenResponseTypeEnum

GetTrustedAgentAuthorizationTokenResponseTypeEnum: "code"

GetTrustedSystemAccessTokenGrantTypeEnum

GetTrustedSystemAccessTokenGrantTypeEnum: "authorization_code" | "refresh_token" | "client_credentials" | "authorization_code_pkce" | "session_bridge"

GetTrustedSystemAccessTokenHintEnum

GetTrustedSystemAccessTokenHintEnum: "ts_ext_on_behalf_of"

GetTrustedSystemAccessTokenIdpOriginEnum

GrantType

GrantType: "authorization_code" | "refresh_token" | "client_credentials" | "authorization_code_pkce" | "session_bridge"

Grant Type

IntrospectTokenTokenTypeHintEnum

IntrospectTokenTokenTypeHintEnum: "access_token" | "refresh_token"

LogoutCustomerHintEnum

LogoutCustomerHintEnum: "all-sessions"

Oauth2ErrorResponse

Oauth2ErrorResponse: { error: string; error_description?: undefined | string; error_uri?: undefined | string } & {}

property: error:
property: error_uri:
property: error_description:

PublicKeyCredentialDescriptor

PublicKeyCredentialDescriptor: { id: string; transports?: Array<PublicKeyCredentialDescriptorTransportsEnum>; type: PublicKeyCredentialDescriptorTypeEnum } & {}

property

type: Credential type.

Max Length: 256

property

id: The base64url-encoded ID of the credential.

Max Length: 64

property

transports: Authenticator transports.

PublicKeyCredentialDescriptorTransportsEnum

PublicKeyCredentialDescriptorTransportsEnum: "usb" | "nfc" | "ble" | "internal"

PublicKeyCredentialDescriptorTypeEnum

PublicKeyCredentialDescriptorTypeEnum: "public-key"

PublicKeyCredentialJson

PublicKeyCredentialJson: { clientExtensionResults?: string | null; id: string; rawId: string; response: PublicKeyCredentialJsonResponse; type: PublicKeyCredentialJsonTypeEnum } & {}

property

id: Base64url-encoded credential ID

Max Length: 256

property

rawId: Base64url-encoded raw credential ID.

Max Length: 256

property

type: The type of credential.

property

clientExtensionResults: WebAuthn client extension results (typically empty).

Max Length: 100

property

response:

PublicKeyCredentialJsonResponse

PublicKeyCredentialJsonResponse: AuthenticatorAssertionResponseJson | AuthenticatorAttestationResponseJson

PublicKeyCredentialJsonTypeEnum

PublicKeyCredentialJsonTypeEnum: "public-key"

PublicKeyCredentialRequestOptions

PublicKeyCredentialRequestOptions: { allowCredentials?: Array<PublicKeyCredentialDescriptor>; challenge?: undefined | string; extensions?: undefined | {}; rpId?: undefined | string; timeout?: undefined | number; userVerification?: PublicKeyCredentialRequestOptionsUserVerificationEnum } & {}

property

challenge: Base64url-encoded challenge.

Max Length: 512

property

timeout: Timeout value in milliseconds.

property

rpId: The ID of the relying party.

Max Length: 256

property

allowCredentials: Allowed credentials for authentication.

property

userVerification: The level of requirement for user verification.

property

extensions: WebAuthn extensions.

PublicKeyCredentialRequestOptionsUserVerificationEnum

PublicKeyCredentialRequestOptionsUserVerificationEnum: "required" | "preferred" | "discouraged"

RegistrationFinishRequest

RegistrationFinishRequest: { channel_id: string; client_id: string; credential: PublicKeyCredentialJson; pwd_action_token: string; username: string } & {}

property

client_id: The ID of the OAuth client.

Max Length: 36

property

username: Username for the credential.

Max Length: 128

property

credential:

property

channel_id: The ID of the channel.

Max Length: 128

property

pwd_action_token: Password action token.

Pattern: /^[0-9]{8}$/
Max Length: 8

ResponseType

ResponseType: "code"

Response Type

RevokeTokenTokenTypeHintEnum

RevokeTokenTokenTypeHintEnum: "access_token" | "refresh_token"

ShopperLoginParameters

ShopperLoginParameters: ShopperLoginPathParameters & BaseUriParameters & ShopperLoginQueryParameters

All parameters that are used by ShopperLogin.

ShopperLoginPathParameters

All path parameters that are used by at least one ShopperLogin method.

ShopperLoginQueryParameters

All query parameters that are used by at least one ShopperLogin method.

TokenActionRequest

TokenActionRequest: { token: string; token_type_hint?: TokenActionRequestTokenTypeHintEnum } & {}

property: token: Token to inspect or revoke.
property: token_type_hint: Token Type Hint

TokenActionRequestTokenTypeHintEnum

TokenActionRequestTokenTypeHintEnum: "access_token" | "refresh_token"

TokenResponse

TokenResponse: { access_token: string; customer_id: string; dnt?: undefined | string; enc_user_id: string; expires_in: number; id_token: string; idp_access_token: string; idp_refresh_token?: undefined | string; refresh_token: string; refresh_token_expires_in: number; token_type: TokenType; usid: string } & {}

property

access_token: Short term shopper JWT that can be used to access Shopper APIs. Valid for 30 minutes. A trusted agent shopper JWT is valid for 15 min.

property

id_token: User ID token. Valid for 30 minutes.

property

refresh_token: Long term refresh token that can be used to refresh an access token. Valid for 30 days. The refresh_token will not be returned for trusted agents JWTs. A JWT for trusted agents expires after 15 minutes and is not refreshable. When expired, then app must restart the authorization flow and make another request to the /trusted-agent/authorize endpoint.

property

expires_in: Remaining access token expiry time, in seconds.

property

refresh_token_expires_in: Remaining refresh token expiry time, in seconds.

property

token_type:

property

usid: The unique shopper ID. Returned when using the client_credentials grant type.

property

customer_id: Customer's ID

property

enc_user_id: MD5 Hashed B2C Commerce user ID in uppercase.

property

idp_access_token: This is the access token that is returned from the IDP. The IDP access token is returned to be able to make calls into the IDP outside of SLAS.

Max Length: 8192

property

idp_refresh_token: This is the refresh token that is returned from the IDP. The IDP refresh token is returned to be able to make calls into the IDP outside of SLAS.

Max Length: 128

property

dnt: Do not track

Max Length: 5

TokenType

TokenType: "Bearer"

Token Type

authenticateCustomerBodyType

authenticateCustomerBodyType: { channel_id: string; client_id?: undefined | string; code_challenge?: undefined | string; redirect_uri: string; response_type?: ResponseType; scope?: undefined | string; state?: undefined | string; usid?: undefined | string }

Type declaration

channel_id: string
Optional client_id?: undefined | string
Optional code_challenge?: undefined | string
redirect_uri: string
Optional response_type?: ResponseType
Optional scope?: undefined | string
Optional state?: undefined | string
Optional usid?: undefined | string

authenticateCustomerPathParameters

authenticateCustomerPathParameters: { organizationId: string }

Type declaration

organizationId: string

authenticateCustomerQueryParameters

authenticateCustomerQueryParameters: {}

Type declaration

authorizeCustomerPathParameters

authorizeCustomerPathParameters: { organizationId: string }

Type declaration

organizationId: string

authorizeCustomerQueryParameters

authorizeCustomerQueryParameters: { channel_id?: undefined | string; client_id: string; code_challenge?: undefined | string; hint?: undefined | string; redirect_uri: string; response_type: "code"; scope?: "openid" | "offline_access" | "email"; state?: undefined | string; ui_locales?: undefined | string; usid?: undefined | string }

Type declaration

Optional channel_id?: undefined | string
client_id: string
Optional code_challenge?: undefined | string
Optional hint?: undefined | string
redirect_uri: string
response_type: "code"
Optional scope?: "openid" | "offline_access" | "email"
Optional state?: undefined | string
Optional ui_locales?: undefined | string
Optional usid?: undefined | string

authorizePasswordlessCustomerBodyType

authorizePasswordlessCustomerBodyType: { callback_uri?: undefined | string; channel_id: string; email?: undefined | string; first_name?: undefined | string; last_name?: undefined | string; locale?: undefined | string; mode: string; phone_number?: undefined | string; user_id: string; usid?: undefined | string }

Type declaration

Optional callback_uri?: undefined | string
channel_id: string
Optional email?: undefined | string
Optional first_name?: undefined | string
Optional last_name?: undefined | string
Optional locale?: undefined | string
mode: string
Optional phone_number?: undefined | string
user_id: string
Optional usid?: undefined | string

authorizePasswordlessCustomerPathParameters

authorizePasswordlessCustomerPathParameters: { organizationId: string }

Type declaration

organizationId: string

authorizePasswordlessCustomerQueryParameters

authorizePasswordlessCustomerQueryParameters: { register_customer?: undefined | string }

Type declaration

Optional register_customer?: undefined | string

authorizeWebauthnRegistrationBodyType

authorizeWebauthnRegistrationBodyType: { callback_uri?: undefined | string; channel_id: string; client_id?: undefined | string; code_challenge?: undefined | string; hint?: undefined | string; idp_name?: undefined | string; locale?: undefined | string; mode: string; user_id: string }

Type declaration

Optional callback_uri?: undefined | string
channel_id: string
Optional client_id?: undefined | string
Optional code_challenge?: undefined | string
Optional hint?: undefined | string
Optional idp_name?: undefined | string
Optional locale?: undefined | string
mode: string
user_id: string

authorizeWebauthnRegistrationPathParameters

authorizeWebauthnRegistrationPathParameters: { organizationId: string }

Type declaration

organizationId: string

authorizeWebauthnRegistrationQueryParameters

authorizeWebauthnRegistrationQueryParameters: {}

Type declaration

finishWebauthnAuthenticationPathParameters

finishWebauthnAuthenticationPathParameters: { organizationId: string }

Type declaration

organizationId: string

finishWebauthnAuthenticationQueryParameters

finishWebauthnAuthenticationQueryParameters: {}

Type declaration

finishWebauthnUserRegistrationPathParameters

finishWebauthnUserRegistrationPathParameters: { organizationId: string }

Type declaration

organizationId: string

finishWebauthnUserRegistrationQueryParameters

finishWebauthnUserRegistrationQueryParameters: {}

Type declaration

getAccessTokenBodyType

getAccessTokenBodyType: { channel_id?: undefined | string; client_id?: undefined | string; code?: undefined | string; code_verifier?: undefined | string; dnt?: undefined | string; grant_type: GrantType; redirect_uri?: undefined | string; refresh_token?: undefined | string; usid?: undefined | string }

Type declaration

Optional channel_id?: undefined | string
Optional client_id?: undefined | string
Optional code?: undefined | string
Optional code_verifier?: undefined | string
Optional dnt?: undefined | string
grant_type: GrantType
Optional redirect_uri?: undefined | string
Optional refresh_token?: undefined | string
Optional usid?: undefined | string

getAccessTokenPathParameters

getAccessTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

getAccessTokenQueryParameters

getAccessTokenQueryParameters: {}

Type declaration

getJwksUriPathParameters

getJwksUriPathParameters: { organizationId: string }

Type declaration

organizationId: string

getJwksUriQueryParameters

getJwksUriQueryParameters: {}

Type declaration

getPasswordLessAccessTokenBodyType

getPasswordLessAccessTokenBodyType: { client_id?: undefined | string; code_verifier?: undefined | string; grant_type: string; hint: string; login_id?: undefined | string; pwdless_login_token: string }

Type declaration

Optional client_id?: undefined | string
Optional code_verifier?: undefined | string
grant_type: string
hint: string
Optional login_id?: undefined | string
pwdless_login_token: string

getPasswordLessAccessTokenPathParameters

getPasswordLessAccessTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

getPasswordLessAccessTokenQueryParameters

getPasswordLessAccessTokenQueryParameters: {}

Type declaration

getPasswordResetTokenBodyType

getPasswordResetTokenBodyType: { callback_uri?: undefined | string; channel_id: string; client_id?: undefined | string; code_challenge?: undefined | string; hint?: undefined | string; idp_name?: undefined | string; locale?: undefined | string; mode: string; user_id: string }

Type declaration

Optional callback_uri?: undefined | string
channel_id: string
Optional client_id?: undefined | string
Optional code_challenge?: undefined | string
Optional hint?: undefined | string
Optional idp_name?: undefined | string
Optional locale?: undefined | string
mode: string
user_id: string

getPasswordResetTokenPathParameters

getPasswordResetTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

getPasswordResetTokenQueryParameters

getPasswordResetTokenQueryParameters: {}

Type declaration

getSessionBridgeAccessTokenBodyType

getSessionBridgeAccessTokenBodyType: { channel_id: string; client_id: string; code: string; code_verifier: string; dnt?: undefined | string; dwsgst?: undefined | string; dwsid: string; dwsrst?: undefined | string; grant_type: string; login_id: string; usid?: undefined | string }

Type declaration

channel_id: string
client_id: string
code: string
code_verifier: string
Optional dnt?: undefined | string
Optional dwsgst?: undefined | string
dwsid: string
Optional dwsrst?: undefined | string
grant_type: string
login_id: string
Optional usid?: undefined | string

getSessionBridgeAccessTokenPathParameters

getSessionBridgeAccessTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

getSessionBridgeAccessTokenQueryParameters

getSessionBridgeAccessTokenQueryParameters: {}

Type declaration

getTrustedAgentAccessTokenBodyType

getTrustedAgentAccessTokenBodyType: { agent_id?: undefined | string; channel_id: string; client_id: string; code_verifier: string; dnt?: undefined | string; grant_type: string; idp_origin: string; login_id: string; state?: undefined | string; usid?: undefined | string }

Type declaration

Optional agent_id?: undefined | string
channel_id: string
client_id: string
code_verifier: string
Optional dnt?: undefined | string
grant_type: string
idp_origin: string
login_id: string
Optional state?: undefined | string
Optional usid?: undefined | string

getTrustedAgentAccessTokenPathParameters

getTrustedAgentAccessTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

getTrustedAgentAccessTokenQueryParameters

getTrustedAgentAccessTokenQueryParameters: {}

Type declaration

getTrustedAgentAuthorizationTokenPathParameters

getTrustedAgentAuthorizationTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

getTrustedAgentAuthorizationTokenQueryParameters

getTrustedAgentAuthorizationTokenQueryParameters: { channel_id: string; client_id: string; code_challenge?: undefined | string; idp_origin: string; login_id: string; redirect_uri: string; response_type: "code" }

Type declaration

channel_id: string
client_id: string
Optional code_challenge?: undefined | string
idp_origin: string
login_id: string
redirect_uri: string
response_type: "code"

getTrustedSystemAccessTokenBodyType

getTrustedSystemAccessTokenBodyType: { channel_id: string; client_id: string; dnt?: undefined | string; email_id?: undefined | string; grant_type: string; hint: string; idp_origin: string; login_id: string; usid?: undefined | string }

Type declaration

channel_id: string
client_id: string
Optional dnt?: undefined | string
Optional email_id?: undefined | string
grant_type: string
hint: string
idp_origin: string
login_id: string
Optional usid?: undefined | string

getTrustedSystemAccessTokenPathParameters

getTrustedSystemAccessTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

getTrustedSystemAccessTokenQueryParameters

getTrustedSystemAccessTokenQueryParameters: {}

Type declaration

getUserInfoPathParameters

getUserInfoPathParameters: { organizationId: string }

Type declaration

organizationId: string

getUserInfoQueryParameters

getUserInfoQueryParameters: { channel_id?: undefined | string }

Type declaration

Optional channel_id?: undefined | string

getWellknownOpenidConfigurationPathParameters

getWellknownOpenidConfigurationPathParameters: { organizationId: string }

Type declaration

organizationId: string

getWellknownOpenidConfigurationQueryParameters

getWellknownOpenidConfigurationQueryParameters: {}

Type declaration

introspectTokenBodyType

introspectTokenBodyType: { token: string; token_type_hint?: undefined | string }

Type declaration

token: string
Optional token_type_hint?: undefined | string

introspectTokenPathParameters

introspectTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

introspectTokenQueryParameters

introspectTokenQueryParameters: {}

Type declaration

logoutCustomerPathParameters

logoutCustomerPathParameters: { organizationId: string }

Type declaration

organizationId: string

logoutCustomerQueryParameters

logoutCustomerQueryParameters: { channel_id?: undefined | string; client_id: string; hint?: undefined | "all-sessions"; refresh_token: string }

Type declaration

Optional channel_id?: undefined | string
client_id: string
Optional hint?: undefined | "all-sessions"
refresh_token: string

resetPasswordBodyType

resetPasswordBodyType: { channel_id: string; client_id: string; code_verifier?: undefined | string; hint?: undefined | string; new_password?: undefined | string; pwd_action_token: string; user_id?: undefined | string }

Type declaration

channel_id: string
client_id: string
Optional code_verifier?: undefined | string
Optional hint?: undefined | string
Optional new_password?: undefined | string
pwd_action_token: string
Optional user_id?: undefined | string

resetPasswordPathParameters

resetPasswordPathParameters: { organizationId: string }

Type declaration

organizationId: string

resetPasswordQueryParameters

resetPasswordQueryParameters: {}

Type declaration

revokeTokenBodyType

revokeTokenBodyType: { token: string; token_type_hint?: undefined | string }

Type declaration

token: string
Optional token_type_hint?: undefined | string

revokeTokenPathParameters

revokeTokenPathParameters: { organizationId: string }

Type declaration

organizationId: string

revokeTokenQueryParameters

revokeTokenQueryParameters: {}

Type declaration

startWebauthnAuthenticationBodyType

startWebauthnAuthenticationBodyType: { channel_id: string; client_id: string; tenant_id?: undefined | string; user_id: string }

Type declaration

channel_id: string
client_id: string
Optional tenant_id?: undefined | string
user_id: string

startWebauthnAuthenticationPathParameters

startWebauthnAuthenticationPathParameters: { organizationId: string }

Type declaration

organizationId: string

startWebauthnAuthenticationQueryParameters

startWebauthnAuthenticationQueryParameters: {}

Type declaration

startWebauthnUserRegistrationBodyType

startWebauthnUserRegistrationBodyType: { channel_id: string; client_id?: undefined | string; display_name?: undefined | string; nick_name?: undefined | string; pwd_action_token: string; user_id: string }

Type declaration

channel_id: string
Optional client_id?: undefined | string
Optional display_name?: undefined | string
Optional nick_name?: undefined | string
pwd_action_token: string
user_id: string

startWebauthnUserRegistrationPathParameters

startWebauthnUserRegistrationPathParameters: { organizationId: string }

Type declaration

organizationId: string

startWebauthnUserRegistrationQueryParameters

startWebauthnUserRegistrationQueryParameters: {}

Type declaration

Variables

Const defaultBaseUri

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