Synq Docs
Management APIUsers

End a user's sessions

Every session and every grant, offline and device ones included: their refresh tokens stop working, a sign-in already in flight is refused, and they sign in again. Each app the sessions had signed in to that registered a `backchannel_logout_uri` gets a logout token. JWT access tokens for the brand's APIs work until they expire (5 to 15 minutes). Needs `org.users.edit`. Recorded as `user.sessions_revoked`.

POST/v1/orgs/{org}/brands/{brand}/users/{user}/revoke-sessions

Every session and every grant, offline and device ones included: their refresh tokens stop working, a sign-in already in flight is refused, and they sign in again. Each app the sessions had signed in to that registered a backchannel_logout_uri gets a logout token. JWT access tokens for the brand's APIs work until they expire (5 to 15 minutes). Needs org.users.edit. Recorded as user.sessions_revoked.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string
brand*string
user*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/orgs/string/brands/string/users/string/revoke-sessions"
{  "sessions_ended": 0}