Tailscale icon

Tailscale

Manage your Tailscale tailnet — devices, routes, and more

Actions32

User → Suspend

AI-generated

Summary

Suspend a user in the specified Tailscale tailnet, effectively disabling their access.

Inputs

  • Authentication — Choose the authentication method for the API request, either API Key or OAuth2. Defaults to API Key.
  • Tailnet Name or ID (required) — Specify the tailnet organization name or ID where the user belongs. Choose from the list or enter '-' for the default tailnet associated with the authenticated user.
  • User Name or ID (required) — Select the user to suspend by choosing their name or ID from the list or by providing an expression.
  • Request Options — Optional settings such as batching, SSL certificate validation, proxy configuration, and request timeout to customize the API request.

Output shape

a single JSON object indicating success and the suspended user's ID

The output confirms whether the suspension was successful with a JSON object containing { success: true, userId: }.

Examples

Example 1: Suspend a specific user named 'john.doe' in the default tailnet

Set Authentication to 'API Key' or 'OAuth2' as per credentials; select '-' for Tailnet; select 'john.doe' from User options; execute to suspend the user.

Links

Discussion