ONLYOFFICE DocSpace icon

ONLYOFFICE DocSpace

Consume ONLYOFFICE DocSpace API

Actions35

User → Disable User

AI-generated

Summary

Disables a user in ONLYOFFICE DocSpace by setting their status to disabled, then returns the user's updated record.

Inputs

  • Authentication (required) — Credential method to use: API Key, Basic Auth, OAuth2, or Personal Access Token. The matching credential must be configured.
  • User ID (required) — The user to disable. Pick from a searchable list of currently enabled users (active status) or enter the ID manually, for example with an expression.

Output shape

One JSON item per input item containing the user's record, as returned by DocSpace after the status change.

The node sends PUT api/2.0/people/status/2 with the user ID, then fetches api/2.0/people/{userId} and returns that response. The returned fields are whatever DocSpace provides. With Continue On Fail enabled, a failed item returns an object with an error message instead.

Examples

Example 1: Offboard a departing employee by disabling their DocSpace account when an HR system fires a webhook.

Authentication: API Key; User ID: Manual mode, expression such as {{ $json.docspaceUserId }}.

Example 2: Manually pick an active user to disable.

Authentication: Personal Access Token; User ID: From List, search and select the user.

Links

Discussion