# revokeConsumerSessions

mutation · in the family [Identity and access](/reference/identity-and-access/)

## What it does

Sign a shopper out everywhere — revoke all their sessions, as staff.

STAFF: the revoke-ALL kill-switch pointed at a consumer; revokes every currently-active session of the named consumer, returns the count. Template class (identity & access admin — the high-authority row); requires the unrestricted capability.

## Careful

Use on compromise suspicion; the customer signs in fresh.

## Who may call it

Capability area: **Identity and access** — Who can sign in and what each role allows — users, roles and their assignments.

- Owner
- System Administrator
- An API key whose scope allows `api:revokeConsumerSessions`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `consumerId` | [ID](/types/#scalars) `ID!` | yes | No further notes. |

## Returns

[Int](/types/#scalars) `Int!` — A whole number.

## Example request

```graphql
mutation ExampleRevokeConsumerSessions($consumerId: ID!) {
  revokeConsumerSessions(consumerId: $consumerId)
}
```

Variables:

```json
{
  "consumerId": "01900000-0000-7000-8000-6e8c92ec0000"
}
```

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

## Example response

```json
{
  "data": {
    "revokeConsumerSessions": 1
  },
  "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](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))