Module

x/windmill/windmill-api/index.ts>UserService

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
windmill-labs/windmill-deno-client
Very Popular
Go to Latest
class UserService
import { UserService } from "https://dotland.deno.dev/x/windmill@v1.415.1/windmill-api/index.ts";

Static Methods

acceptInvite(unnamed 0: { requestBody: { workspace_id: string; username?: string; }; }): CancelablePromise<string>

accept invite to workspace

createToken(unnamed 0: { requestBody: NewToken; }): CancelablePromise<string>

create token

createTokenImpersonate(unnamed 0: { requestBody: NewTokenImpersonate; }): CancelablePromise<string>

create token to impersonate a user (require superadmin)

createUserGlobally(unnamed 0: { requestBody: { email: string; password: string; super_admin: boolean; name?: string; company?: string; }; }): CancelablePromise<string>

create user

declineInvite(unnamed 0: { requestBody: { workspace_id: string; }; }): CancelablePromise<string>

decline invite to workspace

deleteToken(unnamed 0: { tokenPrefix: string; }): CancelablePromise<string>

delete token

deleteUser(unnamed 0: { workspace: string; username: string; }): CancelablePromise<string>

delete user (require admin privilege)

existsEmail(unnamed 0: { email: string; }): CancelablePromise<boolean>

exists email

getCurrentEmail(): CancelablePromise<string>

get current user email (if logged in)

getRunnable(): CancelablePromise<{ workspace: string; endpoint_async: string; endpoint_sync: string; endpoint_openai_sync: string; summary: string; description?: string; kind: string; }>

get all runnables in every workspace

getTutorialProgress(): CancelablePromise<{ progress?: number; }>

get tutorial progress

getUsage(): CancelablePromise<number>

get current usage outside of premium workspaces

getUser(unnamed 0: { workspace: string; username: string; }): CancelablePromise<User>

get user (require admin privilege)

globalUserDelete(unnamed 0: { email: string; }): CancelablePromise<string>

global delete user (require super admin)

globalUsernameInfo(unnamed 0: { email: string; }): CancelablePromise<{ username: string; workspace_usernames: Array<{ workspace_id: string; username: string; }>; }>

global username info (require super admin)

globalUserRename(unnamed 0: { email: string; requestBody: { new_username: string; }; }): CancelablePromise<string>

global rename user (require super admin)

globalUsersExport(): CancelablePromise<Array<ExportedUser>>

global export users (require super admin and EE)

globalUsersOverwrite(unnamed 0: { requestBody: Array<ExportedUser>; }): CancelablePromise<string>

global overwrite users (require super admin and EE)

globalUserUpdate(unnamed 0: { email: string; requestBody: { is_super_admin?: boolean; name?: string; }; }): CancelablePromise<string>

global update user (require super admin)

globalWhoami(): CancelablePromise<GlobalUserInfo>

get current global whoami (if logged in)

isOwnerOfPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<boolean>

is owner of path

leaveInstance(): CancelablePromise<string>

leave instance

listTokens(unnamed 0: { excludeEphemeral?: boolean; page?: number; perPage?: number; }): CancelablePromise<Array<TruncatedToken>>

list token

listUsernames(unnamed 0: { workspace: string; }): CancelablePromise<Array<string>>

list usernames

listUsers(unnamed 0: { workspace: string; }): CancelablePromise<Array<User>>

list users

listUsersAsSuperAdmin(unnamed 0: { page?: number; perPage?: number; activeOnly?: boolean; }): CancelablePromise<Array<GlobalUserInfo>>

list all users as super admin (require to be super amdin)

listUsersUsage(unnamed 0: { workspace: string; }): CancelablePromise<Array<UserUsage>>

list users usage

listWorkspaceInvites(): CancelablePromise<Array<WorkspaceInvite>>

list all workspace invites

login(unnamed 0: { requestBody: Login; }): CancelablePromise<string>

login with password

loginWithOauth(unnamed 0: { clientName: string; requestBody: { code?: string; state?: string; }; }): CancelablePromise<string>

login with oauth authorization flow

logout(): CancelablePromise<string>

logout

refreshUserToken(): CancelablePromise<string>

refresh the current token

setPassword(unnamed 0: { requestBody: { password: string; }; }): CancelablePromise<string>

set password

updateTutorialProgress(unnamed 0: { requestBody: { progress?: number; }; }): CancelablePromise<string>

update tutorial progress

updateUser(unnamed 0: { workspace: string; username: string; requestBody: EditWorkspaceUser; }): CancelablePromise<string>

update user (require admin privilege)

usernameToEmail(unnamed 0: { workspace: string; username: string; }): CancelablePromise<string>

get email from username

whoami(unnamed 0: { workspace: string; }): CancelablePromise<User>

whoami

whois(unnamed 0: { workspace: string; username: string; }): CancelablePromise<User>

whois