Customer Login SSO

Customer Login enables single sign-on (SSO). It allows your apps to programmatically log in a storefront customer by using the login entry point URL: /login/token/{token}.

For more information, see the Customer Login API page.

object

iss

string

Indicates the token’s issuer. This is your application’s client ID, which is obtained during application registration in Developer Portal.

1 validation

iat

integer

Time when the token was generated. This is a numeric value indicating the number of seconds since the Unix epoch.

1 validation

jti

string

Request ID string that must be unique across all requests made by your app. A UUID or other random string would be an appropriate value. Most libraries contain a method for generating a uuid. For testing a UUID generator can be used, but it recommended to use built in libraries.

1 validation

operation

string

Must contain the string “customer_login”.

1 validation

store_hash

string

Store hash identifying the store you are logging into.

1 validation

customer_id

integer

ID of the customer you are logging in, as obtained through the Customer API.

1 validation

redirect_to

string

Optional field containing a relative path for the shopper’s destination after login. Will default to /account.php.

1 validation

request_ip

string

(Optional) Field containing the expected IP address for the request. If provided, BigCommerce will check that it matches the browser trying to log in. If there is not a match, it will be rejected.

1 validation