Class SessionManager

Creates a new session manager instance

Throws

When configuration is invalid

Authenticates with the UniFi controller

Performs login with the configured credentials and establishes a session. Prevents multiple concurrent login attempts and handles authentication errors.

Throws

When login credentials are invalid or login fails

Throws

When unable to connect to the controller

Example

try {
  await sessionManager.login();
  console.log('Login successful');
} catch (error) {
  if (error instanceof AuthenticationError) {
    console.error('Invalid credentials');
  }
}
Copy

Logs out from the UniFi controller

Terminates the current session and clears all authentication state. Always succeeds locally even if the server request fails.

Example

await sessionManager.logout();
console.log('Logged out successfully');
Copy

Ensures the client is authenticated

Checks current authentication status and performs login or session refresh as needed. This method is called automatically by API methods.

Throws

When authentication fails

Throws

When session has expired and refresh fails

Gets current session information

Checks if currently authenticated

Gets the authenticated username

Gets the configured site name

Wraps an API call with automatic authentication

Ensures authentication before executing the API call and handles re-authentication if the session expires during the call.

Throws

When authentication fails

Example

const devices = await sessionManager.withAuth(async () => {
  return httpClient.get('/api/s/default/stat/device');
});
Copy