Skip to main content

Retrieve user login audit events

This example demonstrates how to retrieve user login audit activities in ONLYOFFICE DocSpace. You can either fetch the most recent login records or apply filters such as user ID, action type, and time period.

Before you start​

  1. Replace https://yourportal.onlyoffice.com and YOUR_API_KEY with your actual DocSpace portal URL and API key. Ensure you have the necessary data and permissions to perform migration operations.
  2. Before you can make requests to the API, you need to authenticate. Check out the Personal access tokens page to learn how to obtain and use access tokens.
Full example
// Set API base URL
const API_HOST = 'https://yourportal.onlyoffice.com';
const API_KEY = 'your_api_key';

// Headers with API key for authentication
const HEADERS = {
  Authorization: `Bearer ${API_KEY}`,
  'Content-Type': 'application/json',
};

// Step 1: Retrieve the most recent login audit events
async function getLastLoginEvents() {
  const url = `${API_HOST}/api/2.0/security/audit/login/last`;
  const res = await fetch(url, { method: 'GET', headers: HEADERS });

  if (!res.ok) {
    const text = await res.text();
    console.log(`Login events retrieval failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }

  const loginEvents = await res.json();
  console.log('Last login events retrieved successfully:', loginEvents);
  return loginEvents;
}

// Step 2: Retrieve login events using filters
async function getLoginEventsByFilter({ userId = null, action = null, startDate = null, endDate = null } = {}) {
  const params = new URLSearchParams();
  if (userId) params.set('userId', userId);
  if (action !== null && action !== undefined) params.set('action', String(action)); // 0=login, 1=logout
  if (startDate) params.set('from', startDate);
  if (endDate) params.set('to', endDate);

  const url = `${API_HOST}/api/2.0/security/audit/login/filter${params.toString() ? `?${params.toString()}` : ''}`;
  const res = await fetch(url, { method: 'GET', headers: HEADERS });

  if (!res.ok) {
    const text = await res.text();
    console.log(`Filtered login events retrieval failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }

  const filteredEvents = await res.json();
  console.log('Filtered login events retrieved successfully:', filteredEvents);
  return filteredEvents;
}

// Example usage
(async () => {
  console.log('\nRetrieving the most recent login events:');
  await getLastLoginEvents();

  const user_id = 'user_id_here'; // Replace with actual user ID
  const action = 0;               // 0 = login, 1 = logout
  const start_date = '2025-01-01';
  const end_date = '2025-12-31';

  console.log(`\nRetrieving login events for user ID ${user_id} from ${start_date} to ${end_date}:`);
  await getLoginEventsByFilter({
    userId: user_id,
    action,
    startDate: start_date,
    endDate: end_date,
  });
})();

Step 1: Get recent login audit events​

A GET request is sent to /api/2.0/security/audit/login/last.

This returns the most recent login activities across the DocSpace portal.

async function getLastLoginEvents() {
  const url = `${API_HOST}/api/2.0/security/audit/login/last`;
  const res = await fetch(url, { method: 'GET', headers: HEADERS });

  if (!res.ok) {
    const text = await res.text();
    console.log(`Login events retrieval failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }

  const loginEvents = await res.json();
  console.log('Last login events retrieved successfully:', loginEvents);
  return loginEvents;
}

Step 2: Filter login events by user, action or date​

A GET request is sent to /api/2.0/security/audit/login/filter.

You can apply filters such as:

  • userId: The user ID.
  • action: The login-related action (0 = login, 1 = logout).
  • from: The starting date and time in YYYY-MM-DD format.
  • to: The ending date and time in YYYY-MM-DD format.
async function getLoginEventsByFilter({ userId = null, action = null, startDate = null, endDate = null } = {}) {
  const params = new URLSearchParams();
  if (userId) params.set('userId', userId);
  if (action !== null && action !== undefined) params.set('action', String(action)); // 0=login, 1=logout
  if (startDate) params.set('from', startDate);
  if (endDate) params.set('to', endDate);

  const url = `${API_HOST}/api/2.0/security/audit/login/filter${params.toString() ? `?${params.toString()}` : ''}`;
  const res = await fetch(url, { method: 'GET', headers: HEADERS });

  if (!res.ok) {
    const text = await res.text();
    console.log(`Filtered login events retrieval failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }

  const filteredEvents = await res.json();
  console.log('Filtered login events retrieved successfully:', filteredEvents);
  return filteredEvents;
}