Skip to content

Get customer sign-in settings

GET
/stores/{storeRef}/settings/auth
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/settings/auth \
--header 'x-api-key: <x-api-key>'

Returns how shoppers may sign in to the storefront (password, Google, one-time email code), whether they must verify their email, how long sessions last and the password rules. A store that never changed them gets the defaults.

Required scopes: read:settings

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
password_enabled
required

Whether shoppers can sign in with email and password.

boolean
google_enabled
required

Whether shoppers can sign in with Google.

boolean
otp_enabled
required

Whether shoppers can sign in with a one-time code sent by email.

boolean
require_email_verification
required

Whether a shopper must verify their email address before first sign-in.

boolean
session_ttl_days
required

How many days a shopper stays signed in.

number
access_token_ttl_minutes
required

How many minutes a shopper’s access token stays valid. Read-only: it cannot be changed through this API.

number
password_min_length
required

Minimum password length.

number
password_require_number
required

Whether a password must contain a digit.

boolean
password_require_symbol
required

Whether a password must contain a symbol.

boolean
password_require_uppercase
required

Whether a password must contain an upper-case letter.

boolean

Example generated

{
"password_enabled": true,
"google_enabled": true,
"otp_enabled": true,
"require_email_verification": true,
"session_ttl_days": 1,
"access_token_ttl_minutes": 1,
"password_min_length": 1,
"password_require_number": true,
"password_require_symbol": true,
"password_require_uppercase": true
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}