administration-center-api_session_management.md

title	description	author	ms.topic	ms.devlang	ms.reviewer	ms.search.keywords	ms.date
Business Central Admin Center API - Session Management	Learn about the Business Central administration center API.	jswymer	conceptual	al	solsen	administration, tenant, admin, environment, telemetry	02/24/2023

Session Management

[!INCLUDE2020_releasewave1]

Manage the active sessions on an environment.

Get active sessions

Gets active sessions for an environment.

GET /admin/v2.19/applications/{applicationFamily}/environments/{environmentName}/sessions

Response

{
  value: [
    {
      environmentName: string,
      applicationFamily: string,
      sessionId: int,
      userId: string,
      clientType: string,
      logOnDate: string,
      entryPointOperation: string,
      entryPointObjectName: string,
      entryPointObjectId: string,
      entryPointObjectType: string,
      currentObjectName: string,
      currentObjectId: int,
      currentObjectType: string,
      currentOperationDuration: long
    }
    ,...
  ]
}

Get session details

Gets session information for a specific session id.

GET /admin/v2.19/applications/{applicationFamily}/environments/{environmentName}/sessions/{sessionId}

Response

{
  environmentName: string,
  applicationFamily: string,
  sessionId: int,
  userId: string,
  clientType: string,
  logOnDate: string,
  entryPointOperation: string,
  entryPointObjectName: string,
  entryPointObjectId: string,
  entryPointObjectType: string,
  currentObjectName: string,
  currentObjectId: int,
  currentObjectType: string,
  currentOperationDuration: long
}

Stop and delete a session

Terminates and deletes an active session.

DELETE /admin/v2.19/applications/{applicationFamily}/environments/{environmentName}/sessions/{sessionId}

See Also

The Business Central Administration Center API
Manage Apps
Microsoft Dynamics 365 Business Central Server Administration Tool