Windmill

Windmill User API

The user API from Windmill — 53 operation(s) for user.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 54

POST /auth/login Login with Password #
POST /auth/logout Logout #
GET /auth/is_smtp_configured Check if SMTP is Configured for Password Reset #
GET /auth/is_password_login_disabled Check if Password Login is Disabled Instance-wide #
POST /auth/request_password_reset Request Password Reset Email #
POST /auth/reset_password Reset Password Using Token #
GET /w/{workspace}/users/get/{username} Get User (require Admin Privilege) #
POST /w/{workspace}/users/update/{username} Update User (require Admin Privilege) #
GET /w/{workspace}/users/is_owner/{path} Is Owner of Path #
POST /users/setpassword Set Password #
POST /users/set_password_of/{user} Set Password for a Specific User (require Super Admin) #
POST /users/set_login_type/{user} Set Login Type for a Specific User (require Super Admin) #
POST /users/create Create User #
POST /users/update/{email} Global Update User (require Super Admin) #
GET /users/username_info/{email} Global Username Info (require Super Admin) #
POST /users/rename/{email} Global Rename User (require Super Admin) #
DELETE /users/delete/{email} Global Delete User (require Super Admin) #
POST /users/overwrite Global Overwrite Users (require Super Admin and EE) #
GET /users/export Global Export Users (require Super Admin and EE) #
GET /users/ext_jwt_tokens List External JWT Tokens (ee Only) #
POST /users/onboarding Submit User Onboarding Data #
DELETE /w/{workspace}/users/delete/{username} Delete User (require Admin Privilege) #
GET /w/{workspace}/users/offboard_preview/{username} Preview Offboarding for a Workspace User (require Admin Privilege) #
POST /w/{workspace}/users/offboard/{username} Offboard a Workspace User (reassign Objects, Optionally Delete User) #
GET /users/offboard_preview/{email} Preview Global Offboarding for a User Across All Workspaces (require Super… #
POST /users/offboard/{email} Offboard a User Globally (reassign Objects Across Workspaces, Optionally Delete) #
POST /w/{workspace}/users/convert_to_group/{username} Convert Manual User to Group User (require Admin Privilege) #
GET /users/email Get Current User Email (if Logged In) #
GET /users/refresh_token Refresh the Current Token #
GET /users/tutorial_progress Get Tutorial Progress #
POST /users/tutorial_progress Update Tutorial Progress #
POST /users/leave_instance Leave Instance #
GET /users/usage Get Current Usage Outside of Premium Workspaces #
GET /users/all_runnables Get All Runnables in Every Workspace #
GET /users/whoami Get Current Global Whoami (if Logged In) #
GET /users/list_invites List All Workspace Invites #
GET /w/{workspace}/users/whoami Whoami #
POST /users/accept_invite Accept Invite to Workspace #
POST /users/decline_invite Decline Invite to Workspace #
POST /w/{workspace}/users/impersonate_service_account Impersonate a Service Account #
POST /w/{workspace}/users/exit_impersonation Exit Service Account Impersonation #
GET /w/{workspace}/users/whois/{username} Whois #
GET /users/exists/{email} Exists Email #
GET /users/list_as_super_admin List All Users as Super Admin (require to be Super Amdin) #
GET /w/{workspace}/users/list List Users #
GET /w/{workspace}/users/list_usage List Users Usage #
GET /w/{workspace}/users/list_usernames List Usernames #
GET /w/{workspace}/users/username_to_email/{username} Get Email from Username #
POST /users/tokens/create Create Token #
POST /users/tokens/impersonate Create Token to Impersonate a User (require Superadmin) #
DELETE /users/tokens/delete/{token_prefix} Delete Token #
POST /users/tokens/update_scopes/{token_prefix} Update Scopes of an Existing Token (owner Only) #
GET /users/tokens/list List Token #
POST /oauth/login_callback/{client_name} Login with Oauth Authorization Flow #

Documentation

📖
Documentation
https://www.windmill.dev/docs/intro
📖
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
📖
Authentication
https://www.windmill.dev/docs/core_concepts/authentification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/openapi/windmill-user-api-openapi.yml

Other Resources

🔗
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
🔗
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
🔗
CLI
https://www.windmill.dev/docs/advanced/cli
🔗
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
🔗
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
🔗
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/rules/windmill-api-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/windmill-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

windmill-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.694.0
  title: Windmill User API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:


# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/openapi/windmill-user-api-openapi.yml