FluxbaseAdmin

Admin client for managing Fluxbase instance

Constructors

Constructor

new FluxbaseAdmin(fetch): FluxbaseAdmin

Parameters

Parameter	Type
fetch	FluxbaseFetch

Returns

FluxbaseAdmin

Properties

Property	Modifier	Type	Description
ai	public	FluxbaseAdminAI	AI manager for chatbot and provider management (create, update, delete, sync)
ddl	public	DDLManager	DDL manager for database schema and table operations
emailTemplates	public	EmailTemplateManager	Email template manager for customizing authentication and notification emails
functions	public	FluxbaseAdminFunctions	Functions manager for edge function management (create, update, delete, sync)
impersonation	public	ImpersonationManager	Impersonation manager for user impersonation and audit trail
jobs	public	FluxbaseAdminJobs	Jobs manager for background job management (create, update, delete, sync, monitoring)
management	public	FluxbaseManagement	Management namespace for client keys, webhooks, and invitations
migrations	public	FluxbaseAdminMigrations	Migrations manager for database migration operations (create, apply, rollback, sync)
oauth	public	FluxbaseOAuth	OAuth configuration manager for provider and auth settings
realtime	public	FluxbaseAdminRealtime	Realtime manager for enabling/disabling realtime on tables
rpc	public	FluxbaseAdminRPC	RPC manager for procedure management (create, update, delete, sync, execution monitoring)
serviceKeys	public	ServiceKeysManager	Service keys manager for API key management (list, create, rotate, revoke)
settings	public	FluxbaseSettings	Settings manager for system and application settings
storage	public	FluxbaseAdminStorage	Storage manager for bucket and object management (list, create, delete, signed URLs)

Methods

clearToken()

clearToken(): void

Clear admin token

Returns

void

---

deleteUser()

deleteUser(userId, type?): Promise<DataResponse<DeleteUserResponse>>

Delete a user

Permanently deletes a user and all associated data

Parameters

Parameter	Type	Default value	Description
userId	string	undefined	User ID to delete
type	"app" | "dashboard"	"app"	User type (‘app’ or ‘dashboard’)

Returns

Promise<DataResponse<DeleteUserResponse>>

Deletion confirmation

Example

await admin.deleteUser('user-uuid');
console.log('User deleted');

---

getHealth()

getHealth(): Promise<DataResponse<HealthResponse>>

Get system health status

Returns

Promise<DataResponse<HealthResponse>>

Health status including database and realtime service status

Example

const { data, error } = await admin.getHealth();
if (data) {
  console.log('Status:', data.status);
  console.log('Database:', data.services.database);
  console.log('Realtime:', data.services.realtime);
}

---

getSetupStatus()

getSetupStatus(): Promise<DataResponse<AdminSetupStatusResponse>>

Check if initial admin setup is needed

Returns

Promise<DataResponse<AdminSetupStatusResponse>>

Setup status indicating if initial setup is required

Example

const status = await admin.getSetupStatus();
if (status.needs_setup) {
  console.log('Initial setup required');
}

---

getToken()

getToken(): string | null

Get current admin token

Returns

string | null

---

getUserById()

getUserById(userId, type?): Promise<DataResponse<EnrichedUser>>

Get a user by ID

Fetch a single user’s details by their user ID

Parameters

Parameter	Type	Default value	Description
userId	string	undefined	User ID to fetch
type	"app" | "dashboard"	"app"	User type (‘app’ or ‘dashboard’)

Returns

Promise<DataResponse<EnrichedUser>>

User details with metadata

Example

// Get an app user
const user = await admin.getUserById('user-123');

// Get a dashboard user
const dashboardUser = await admin.getUserById('admin-456', 'dashboard');
console.log('User email:', dashboardUser.email);
console.log('Last login:', dashboardUser.last_login_at);

---

inviteUser()

inviteUser(request, type?): Promise<DataResponse<InviteUserResponse>>

Invite a new user

Creates a new user and optionally sends an invitation email

Parameters

Parameter	Type	Default value	Description
request	InviteUserRequest	undefined	User invitation details
type	"app" | "dashboard"	"app"	User type (‘app’ or ‘dashboard’)

Returns

Promise<DataResponse<InviteUserResponse>>

Created user and invitation details

Example

const response = await admin.inviteUser({
  email: 'newuser@example.com',
  role: 'user',
  send_email: true
});

console.log('User invited:', response.user.email);
console.log('Invitation link:', response.invitation_link);

---

listUsers()

listUsers(options?): Promise<DataResponse<ListUsersResponse>>

List all users

Parameters

Parameter	Type	Description
options	ListUsersOptions	Filter and pagination options

Returns

Promise<DataResponse<ListUsersResponse>>

List of users with metadata

Example

// List all users
const { users, total } = await admin.listUsers();

// List with filters
const result = await admin.listUsers({
  exclude_admins: true,
  search: 'john',
  limit: 50,
  type: 'app'
});

---

login()

login(request): Promise<DataResponse<AdminAuthResponse>>

Admin login

Authenticate as an admin user

Parameters

Parameter	Type	Description
request	AdminLoginRequest	Login request containing email and password

Returns

Promise<DataResponse<AdminAuthResponse>>

Authentication response with tokens

Example

const response = await admin.login({
  email: 'admin@example.com',
  password: 'password123'
});

// Token is automatically set in the client
console.log('Logged in as:', response.user.email);

---

logout()

logout(): Promise<VoidResponse>

Admin logout

Invalidates the current admin session

Returns

Promise<VoidResponse>

Example

await admin.logout();
localStorage.removeItem('admin_token');

---

me()

me(): Promise<DataResponse<AdminMeResponse>>

Get current admin user information

Returns

Promise<DataResponse<AdminMeResponse>>

Current admin user details

Example

const { user } = await admin.me();
console.log('Logged in as:', user.email);
console.log('Role:', user.role);

---

refreshToken()

refreshToken(request): Promise<DataResponse<AdminRefreshResponse>>

Refresh admin access token

Parameters

Parameter	Type	Description
request	AdminRefreshRequest	Refresh request containing the refresh token

Returns

Promise<DataResponse<AdminRefreshResponse>>

New access and refresh tokens

Example

const refreshToken = localStorage.getItem('admin_refresh_token');
const response = await admin.refreshToken({ refresh_token: refreshToken });

// Update stored tokens
localStorage.setItem('admin_token', response.access_token);
localStorage.setItem('admin_refresh_token', response.refresh_token);

---

resetUserPassword()

resetUserPassword(userId, type?): Promise<DataResponse<ResetUserPasswordResponse>>

Reset user password

Generates a new password for the user and optionally sends it via email

Parameters

Parameter	Type	Default value	Description
userId	string	undefined	User ID
type	"app" | "dashboard"	"app"	User type (‘app’ or ‘dashboard’)

Returns

Promise<DataResponse<ResetUserPasswordResponse>>

Reset confirmation message

Example

const response = await admin.resetUserPassword('user-uuid');
console.log(response.message);

---

setToken()

setToken(token): void

Set admin authentication token

Parameters

Parameter	Type
token	string

Returns

void

---

setup()

setup(request): Promise<DataResponse<AdminAuthResponse>>

Perform initial admin setup

Creates the first admin user and completes initial setup. This endpoint can only be called once.

Parameters

Parameter	Type	Description
request	AdminSetupRequest	Setup request containing email, password, and name

Returns

Promise<DataResponse<AdminAuthResponse>>

Authentication response with tokens

Example

const response = await admin.setup({
  email: 'admin@example.com',
  password: 'SecurePassword123!',
  name: 'Admin User'
});

// Store tokens
localStorage.setItem('admin_token', response.access_token);

---

updateUserRole()

updateUserRole(userId, role, type?): Promise<DataResponse<EnrichedUser>>

Update user role

Changes a user’s role

Parameters

Parameter	Type	Default value	Description
userId	string	undefined	User ID
role	string	undefined	New role
type	"app" | "dashboard"	"app"	User type (‘app’ or ‘dashboard’)

Returns

Promise<DataResponse<EnrichedUser>>

Updated user

Example

const user = await admin.updateUserRole('user-uuid', 'admin');
console.log('User role updated:', user.role);