users_sessions_revoke

Tool

users_sessions_revoke

Revoke end-user sessions: pass `sessionId` to sign out one device, or `userId` to sign out every device of that user.

Revoke end-user sessions: pass `sessionId` to sign out one device, or `userId` to sign out every device of that user. Revocation is immediate in this toolkit's own checked verification; an access token already issued keeps verifying locally until it expires (≤10 minutes by default). Returns how many sessions this call actually revoked — a second call on the same target returns 0.

Behavior

HTTP: POST /users/sessions/revoke

Arguments

Name	Type	Required	Description
userId	string	—	Revoke every session of this user.
sessionId	string	—	Revoke exactly this session.

Response

Field	Type	Always	Description
revoked	integer	•	How many sessions were revoked. Zero when there was nothing live to revoke.

Try it

Revoke end-user sessions: pass `sessionId` to sign out one device, or `userId` to sign out every device of that user.

When to use

Example

Ask your agent something like this:

Revoke end-user sessions: pass `sessionId` to sign out one device, or `userId` to sign out every device of that user.

The agent will invoke users_sessions_revoke with these arguments:

{}