---
title: "revoke token · RUAL Documentation"
description: "Revokes all access tokens based of the authentication document."
canonical: https://docs.rual.nl/block-types/session%20management/function_sessions_management_revoke
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# revoke token

This block is part of the [`session management`](https://docs.rual.nl/block-types/session%20management) group and was last modified in core [`v12.0.7`](https://docs.rual.nl/core-versions/120007).

Revokes all access tokens based of the authentication document.

- flow `flow`

- auth. guid required `value` The GUID of authentication storage document, **not** the access token.

- flow `flow`

- revoked `condition` Returns true if we could successfully revoke the given authentication document and the access-tokens generated from it.

- error `value`

Revokes the authentication session identified by the guid pin (the auth document's GUID, not the access token). revoked=true when the revoke call succeeds; revoked=false with error "No guid given." when guid is empty or unwired, or with the revoke error message on failure.

A typical wiring for [revoke token](https://docs.rual.nl/block-types/session%2520management/function_sessions_management_revoke): [branch](https://docs.rual.nl/block-types/flow/branch) feeds the `flow` pin; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `guid` pin; the `flow` out pin feeds [branch](https://docs.rual.nl/block-types/flow/branch).

[![Studio canvas example for the revoke token block: typical wiring for revoke token.](https://docs.rual.nl/canvas-examples/function_sessions_management_revoke.png)](https://docs.rual.nl/canvas-examples/function_sessions_management_revoke.png?v=3)

## Commonly used with

In production blueprints, this block is most often wired together with:

- [branch](https://docs.rual.nl/block-types/flow/branch): wired in both directions with this block.

- [get fields](https://docs.rual.nl/block-types/object/object_field_getter_multiple): feeds into this block. Gets the selected fields from the given object.

- [new object](https://docs.rual.nl/block-types/object/object_new_fields): this block feeds into it. Builds a new object filled with the given fields.

- [create](https://docs.rual.nl/block-types/globals/trigger_custom_function): feeds into this block. Creates a new function that can be executed using the given name.

## Version history

Introduced in [`v12.0.7`](https://docs.rual.nl/core-versions/120007).

- [Back to `session management`](https://docs.rual.nl/block-types/session%20management): Return to the main group to view all sub-groups

- [Back to `session management`](https://docs.rual.nl/block-types/session%20management?group=session%20management): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)