BigCommerce · Schema

Customer Login SSO

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
iss string Indicates the token’s issuer. This is your application’s client ID, which is obtained during application registration in Developer Portal.
iat integer Time when the token was generated. This is a numeric value indicating the number of seconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time).
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 test
operation string Must contain the string “customer_login”.
store_hash string Store hash identifying the store you are logging into.
customer_id integer ID of the customer you are logging in, as obtained through the Customer API.
redirect_to string Optional field containing a relative path for the shopper’s destination after login. Will default to `/account.php`.
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.
View JSON Schema on GitHub

JSON Schema

bigcommerce-customerloginsso-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/customerLoginSSO",
  "title": "Customer Login SSO",
  "type": "object",
  "properties": {
    "iss": {
      "type": "string",
      "description": "Indicates the token\u2019s issuer. This is your application\u2019s client ID, which is obtained during application registration in Developer Portal.",
      "example": "\"1234r5t6y7u8i9o0p\""
    },
    "iat": {
      "type": "integer",
      "description": "Time when the token was generated. This is a numeric value indicating the number of seconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time).",
      "example": 1535393113
    },
    "jti": {
      "type": "string",
      "description": "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](https://www.uuidgenerator.net/) can be used, but it recommended to use built in libraries.",
      "example": "\"20b7c03e-00da-4d29-91bf-2aa06a57575b\""
    },
    "operation": {
      "type": "string",
      "description": "Must contain the string \u201ccustomer_login\u201d.",
      "example": "\"customer_login\""
    },
    "store_hash": {
      "type": "string",
      "description": "Store hash identifying the store you are logging into.\n",
      "example": "\"abc123\""
    },
    "customer_id": {
      "type": "integer",
      "description": "ID of the customer you are logging in, as obtained through the Customer API.\n",
      "example": 2
    },
    "redirect_to": {
      "type": "string",
      "description": "Optional field containing a relative path for the shopper\u2019s destination after login. Will default to `/account.php`.\n",
      "default": "/account.php"
    },
    "request_ip": {
      "type": "string",
      "description": "**(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.\n",
      "example": "\"111.222.333.444\""
    }
  },
  "x-internal": false
}