Skip to content

Get the store's sign-in options

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

Returns which sign-in methods the store has turned on and its password rules, so a sign-in form can show the right buttons and hints before the shopper types anything. Rate limited to 20 requests per minute per store and client IP.

storeRef
required
string

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

Media typeapplication/json
object
password_policy
required

The password rules to show before the shopper submits.

object
min_length
required

Minimum password length.

number
require_number
required

Whether a password must contain a digit.

boolean
require_symbol
required

Whether a password must contain a symbol.

boolean
require_uppercase
required

Whether a password must contain an uppercase letter.

boolean
password_enabled
required

Whether sign-up and sign-in with email and password is on.

boolean
google_enabled
required

Whether sign-in with Google is on.

boolean
otp_enabled
required

Whether sign-in with a one-time code sent by email is on.

boolean
require_email_verification
required

Whether a shopper must verify their email before they can sign in with a password.

boolean

Example generated

{
"password_policy": {
"min_length": 1,
"require_number": true,
"require_symbol": true,
"require_uppercase": true
},
"password_enabled": true,
"google_enabled": true,
"otp_enabled": true,
"require_email_verification": 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"
}

Too many requests; wait a little before retrying.

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"
}