Skip to content

Sign out everywhere

POST
/tenant/stores/{storeRef}/auth/logout-all
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/tenant/stores/example/auth/logout-all \
--header 'Authorization: Bearer <token>' \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Revokes every session of the signed-in shopper and returns how many were revoked.

storeRef
required
string

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

Media typeapplication/json
object
revoked
required

How many sessions were revoked.

number

Example generated

{
"revoked": 1
}

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