Revoke member tokens

POST/v1/members/{id}/revoke_tokens

Ends every member token issued for this member, at once. Use it for "sign out everywhere", after a password reset, or when you suspect a device was lost. For a normal sign-out on one device the app forgets its token; you don't need this call.

Permissions: Secret key with members:write.

Guide

Authentication

Request headers#

Idempotency-Keystring
Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
Max Length 255

Path parameters#

idstring (uuid)Required
The member id.

Returns 204 with no body. Calls with a revoked token return 401 token_expired, the same as an expired one, so the app needs no extra handling. Your server must also stop issuing new tokens to sessions you signed out, or the app will get a fresh one on its next request.

Response fields#

Returns 204 with no body.

POST/v1/members/{id}/revoke_tokens

1
2curl -X POST $UNPLUG_API/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/revoke_tokens \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch(`${process.env.UNPLUG_API}/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/revoke_tokens`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.post(
    f"{os.environ['UNPLUG_API']}/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/revoke_tokens",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Error descriptions#

404Not found

member_not_found

No member with this id.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#member_not_found",
  "title": "Not found",
  "status": 404,
  "code": "member_not_found",
  "detail": "No member with this id."
}