logout

mutation · in the family Your own session

What it does

Sign out — end the current session.

Revoke the caller's current session — idempotent; the next call with the token dies.

Who may call it

Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.

• Owner
• System Administrator
• Manager
• Associate Manager
• Warehouse Associate
• Sales Associate
• Cashier
• An API key whose scope allows api:logout

Returns

Boolean Boolean! — True or false.

Example request

mutation ExampleLogout {
  logout
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "logout": true
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)