ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

Room → Remove User

AI-generated

Summary

Removes a single user from an ONLYOFFICE DocSpace room by revoking their access (sets access level to 0), identifying the user by ID or by email, and returns the user's share record fetched before removal.

Inputs

  • Authentication (required) — Credential type used for the API call: API Key, Basic Auth, OAuth2 or Personal Access Token.
  • Room ID (required) — Room to remove the user from. Pick from a searchable list of rooms or enter the numeric ID manually.
  • User ID (required) — User to remove. Pick from a searchable list of the room's current users (including shared) or enter the ID manually. Hidden when User Email is set. Provide this or User Email, not both.
  • User Email (required) — Email of the user to remove. Hidden when User ID is set. Provide this or User ID, not both.

Output shape

One JSON item per input item: the room share entry (array response from the room's share endpoint filtered by the user's email) as it was before removal.

The share info is fetched before the removal request, so it shows the user's prior access rather than a post-removal state. If a User ID is given, the node first looks up the user's email and uses it for the filter. The node errors if both or neither of User ID/Email are provided. With Continue On Fail enabled, failures return an item with an error message.

Examples

Example 1: Offboard a departing employee from a project room by email

Authentication: API Key; Room ID: select 'Project X' from list; User Email: name@email.com

Example 2: Remove a user picked from the room's member list

Room ID: From List; User ID: From List (listRemovableUsers); leave User Email empty

Example 3: Dynamically remove users from a room based on incoming data

Room ID: Manual 12345; User Email: expression {{ $json.email }}

Links

Discussion