ONLYOFFICE DocSpace Security API

The browsable version of this reference, with a request builder and code samples, is published at https://api.onlyoffice.com/docspace/api-backend/usage-api/.

All URIs are relative to https://yourportal.onlyoffice.com, where the host is the address of your DocSpace instance.

Access to DevTools

Method	HTTP request	Description
setTenantDevToolsAccessSettings	POST /api/2.0/settings/devtoolsaccess	Set the Developer Tools access settings

Active connections

Method	HTTP request	Description
getAllActiveConnections	GET /api/2.0/security/activeconnections	Get active connections
logOutActiveConnection	PUT /api/2.0/security/activeconnections/logout/{loginEventId}	Log out one connection
logOutAllActiveConnectionsChangePassword	PUT /api/2.0/security/activeconnections/logoutallchangepassword	Log out and reset password
logOutAllActiveConnectionsForUser	PUT /api/2.0/security/activeconnections/logoutall/{userId}	Log out a user everywhere
logOutAllExceptThisConnection	PUT /api/2.0/security/activeconnections/logoutallexceptthis	Log out other connections

Audit trail data

Method	HTTP request	Description
createAuditTrailReport	POST /api/2.0/security/audit/events/report	Start audit trail report
getAuditEventsByFilter	GET /api/2.0/security/audit/events/filter	Get filtered audit events
getAuditSettings	GET /api/2.0/security/audit/settings/lifetime	Get audit lifetime settings
getAuditTrailMappers	GET /api/2.0/security/audit/mappers	Get audit trail mappers
getAuditTrailReport	GET /api/2.0/security/audit/events/report	Get audit trail report status
getAuditTrailTypes	GET /api/2.0/security/audit/types	Get audit trail types
getLastAuditEvents	GET /api/2.0/security/audit/events/last	Get recent audit events
setAuditSettings	POST /api/2.0/security/audit/settings/lifetime	Set audit lifetime settings
terminateAuditTrailReport	DELETE /api/2.0/security/audit/events/report	Terminate audit trail report

Banners visibility

Method	HTTP request	Description
setTenantBannerSettings	POST /api/2.0/settings/banner	Set the banners visibility

CSP

Method	HTTP request	Description
configureCsp	POST /api/2.0/security/csp	Configure CSP settings
getCspSettings	GET /api/2.0/security/csp	Get CSP settings

Firebase

Method	HTTP request	Description
docRegisterPusnNotificationDevice	POST /api/2.0/settings/push/docregisterdevice	Register a push device
subscribeDocumentsPushNotification	PUT /api/2.0/settings/push/docsubscribe	Set push subscription

Login history

Method	HTTP request	Description
createLoginHistoryReport	POST /api/2.0/security/audit/login/report	Start login history report
getLastLoginEvents	GET /api/2.0/security/audit/login/last	Get recent login events
getLoginEventsByFilter	GET /api/2.0/security/audit/login/filter	Get filtered login events
getLoginHistoryReport	GET /api/2.0/security/audit/login/report	Get login history report status
terminateLoginHistoryReport	DELETE /api/2.0/security/audit/login/report	Terminate login history report

OAuth2

Method	HTTP request	Description
generateJwtToken	GET /api/2.0/security/oauth2/token	Generate JWT token

SMTP settings

Method	HTTP request	Description
getSmtpOperationStatus	GET /api/2.0/smtpsettings/smtp/test/status	Get SMTP test status
getSmtpSettings	GET /api/2.0/smtpsettings/smtp	Get SMTP settings
resetSmtpSettings	DELETE /api/2.0/smtpsettings/smtp	Reset SMTP settings
saveSmtpSettings	POST /api/2.0/smtpsettings/smtp	Save SMTP settings
testSmtpSettings	GET /api/2.0/smtpsettings/smtp/test	Test SMTP settings

Authorization

cookieAuth

• Type: API key
• API key parameter name: asc_auth_key
• Location:

bearerAuth

• Type: HTTP Bearer Token authentication

asc_auth_key

• Type: API key
• API key parameter name: asc_auth_key
• Location:

Basic

• Type: HTTP basic authentication

Bearer

• Type: HTTP Bearer Token authentication (JWT)

ApiKeyBearer

• Type: API key
• API key parameter name: ApiKeyBearer
• Location: HTTP header

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL:
• Scopes:
  • read: Read access to protected resources
  • write: Write access to protected resources

OpenId

x-signature

• Type: API key
• API key parameter name: x-signature
• Location: