DocSpace
Document Server
Plugins and Macros
Document Builder
Desktop Editors
Community Server
Get Started
Overview
JavaScript SDK
Basic concepts
Initialization modes
Manager
Room-selector
File-selector
Editor
Viewer
System
Config
Methods
Events
Plugins SDK
Basic concepts
Getting started
Creating plugin template
Plugin structure
Coding plugin
Plugin types
Plugin
SettingsPlugin
APIPlugin
ContextMenuPlugin
InfoPanelPlugin
MainButtonPlugin
ProfileMenuPlugin
EventListenerPlugin
FilePlugin
Plugin items
ContextMenuItem
InfoPanelItem
MainButtonItem
ProfileMenuItem
FileItem
EventListenerItem
Plugin message
Events
Plugin components
Box
Button
Checkbox
ComboBox
Component
CreateDialog
IFrame
img
Input
Label
ModalDialog
Skeleton
Text
TextArea
Toast
ToggleButton
Building plugin
Config
Adding plugin
Storybook
How to create plugin step by step
Planning
Developing
Step 1. Create a plugin template
Step 2. Configure the plugin entry point
Step 3. Add plugin icons
Step 4. Configure the plugin's interface elements
Step 5. Create plugin types
Step 6. Create the settings plugin type
Step 7. Create the main plugin code file
Testing
Using
API backend
Basic concepts
How it works
Passing authentication
Long-running operations
Uploading large files
Webhooks
authentication
Authenticate a user
Authenticate a user by code
Check authentication
Log out
Open confirmation email URL
Send SMS code
Set a mobile phone
backup
Create the backup schedule
Delete the backup
Delete the backup history
Delete the backup schedule
Get the backup history
Get the backup progress
Get the backup schedule
Get the restoring progress
Start the backup
Start the restoring process
capabilities
Get portal capabilities
files
Files
Add template files
Change version history
Check the form draft
Copy a file
Create a file
Create a file in the "My documents" section
Create a text file in the "My documents" section
Create a txt file
Create an HTML file
Create an HTML file in the "My documents" section
Create the editing session
Create thumbnails
Delete a file
Delete template files
Get changes URL
Get file download link
Get file download link asynchronously
Get file information
Get file properties
Get file versions
Get reference data
Get third-party file information
Get users with the access to the protected file
Get version history
Lock a file
Open a file
Restore a file version
Returns primary external link
Save file edits
Save file properties to a file
Save file properties to files
Start file editing
Track file editing
Update a file
Folders
Create a folder
Delete a folder
Get a folder by ID
Get filtered sections
Get folder information
Get new folder items
Get subfolders
Get the "My documents" section
Get the "Private Room" section
Get the "Trash" section
Get the folder path
Insert a file
Insert a file to the "My documents" section
Rename a folder
Upload a file
Upload a file to the "My documents" section
Operations
Bulk download
Check files and folders for conflicts
Chunked upload
Copy to a folder
Delete files and folders
Empty the "Trash" folder
Finish active operations
Get active operations
Get conversion status
Mark as read
Move to a folder
Start file conversion
Update a comment
Rooms
Accept an invitation
Add room tags
Archive a room
Create a room
Create a room logo
Create a tag
Create a third-party room
Delete tags
Get primary external link
Get room access rights
Get room information
Get room links
Get rooms
Get tags
Pin a room
Remove a room
Remove a room logo
Remove room tags
Rename a room
Resend room invitations
Set an external or invitation link
Set room access rights
Unarchive a room
Unpin a room
Upload an image for room logo
Settings
Ask a new file name
Change the ability to store the forcesaved files
Change the ability to upload original formats
Change the archive format (using body parameters)
Change the default access rights
Change the external sharing ability
Change the external sharing ability on social networks
Change the forcasaving ability
Change the third-party settings access
Check the document service URL
Check the Private Room availability
Confirm the file deletion
Get file settings
Get the Documents information
Get the trash bin auto-clearing setting
Update a file version if it exists
Update the trash bin auto-clearing setting
Third-party integration
Get a third-party account backup
Get common third-party services
Get providers
Get third-party accounts
Open a third-party file
Remove a third-party account
Save a third-party account
Save a third-party account backup
people
Contacts
Delete user contacts
Set user contacts
Update user contacts
Password
Change a user password
Remind a user password
Photos
Create photo thumbnails
Delete a user photo
Get a user photo
Update a user photo
Upload a user photo
Profiles
Add a user
Delete a user
Delete my profile
Delete users
Get a profile by user email
Get a profile by user name
Get my profile
Get profiles
Invite users
Register a Personal account
Resend activation emails
Send a notification to change a phone
Send instructions to change email
Send the deletion instructions
Update a user
Update user language
Search
Search users
Search users (using query parameters)
Search users and their information by extended filter
Search users by extended filter
Search users by status filter
Theme
Change portal theme
Get portal theme
Third-party accounts
Create a third-pary account
Get third-party accounts
Link a third-pary account
Unlink a third-pary account
User data
Get the deletion progress
Get the reassignment progress
Start the data deletion
Start the data reassignment
Terminate the data deletion
Terminate the data reassignment
User status
Change a user status
Get profiles by status
Set an activation status to the users
User type
Change a user type
portal
Quota
Get a portal quota
Get a portal tariff
Get the recommended quota
Get the used portal space
Settings
Deactivate a portal
Delete a portal
Delete a portal immediately
Get a path to the portal
Get a portal
Get a shortened link
Restore a portal
Send removal instructions
Send suspension instructions
Users
Get a number of portal users
Get a user by ID
Get an invitation link
Mark a gift message as read
Send congratulations
security
Active connections
Get active connections
Log out and change password
Log out for the user by ID
Log out from all connections
Log out from the connection
Audit trail data
Generate the audit trail report
Get audit trail data
Get audit trail mappers
Get audit trail types
Get filtered audit trail data
Get the audit trail settings
Set the audit trail settings
Firebase
Save the Documents Firebase device token
Subscribe to Documents push notification
Login history
Generate the login history report
Get filtered login events
Get login history
SMTP settings
Get the SMTP settings
Reset the SMTP settings
Save the SMTP settings
settings
Authorization
Get the authorization services
Save the authorization keys
Common settings
Close the admin helper notification
Complete the Wizard settings
Delete a color theme
Get a color theme
Get a portal logo
Get hostname
Get supporrted languages
Get the payment settings
Get the portal settings
Get the socket settings
Get time zones
Save a color theme
Save the DNS settings
Save the mail domain settings
Update the email activation settings
Cookies
Get cookies lifetime
Update cookies lifetime
Custom navigation
Add a custom navigation item
Delete a custom navigation item
Get a custom navigation item by ID
Get a custom navigation item sample
Get the custom navigation items
Encryption
Get the storage encryption progress
Start the storage encryption process
Greeting settings
Check the default greeting settings
Get greeting settings
Restore the greeting settings
Save the greeting settings
IP restrictions
Get the IP portal restrictions
Get the IP restriction settings
Save the IP restrictions
Update the IP restriction settings
License
Activate a license
Refresh the license
Request a license
Upload a license
Login settings
Get login settings
Update login settings
Messages
Enable the administrator message settings
Send a message to the administrator
Sends an invitation email
Notifications
Check notification availability
Enable notifications
Get room notification settings
Set room notification status
Owner
Send the owner change instructions
Update the portal owner
Security
Check a product administrator
Get the enabled modules
Get the module availability
Get the password settings
Get the product administrators
Get the security settings
Set a product administrator
Set the access settings to products
Set the module security settings
Set the password settings
SSO
Get the default SSO settings
Get the SSO settings
Get the SSO settings constants
Reset the SSO settings
Save the SSO settings
Statistics
Get the space usage statistics
Get the visit statistics
Storage
Get Amazon regions
Get storages
Get the backup storages
Get the CDN storages
Get the storage progress
Reset the CDN storage settings
Reset the storage settings
Update a storage
Update the CDN storage
Team templates
Create a custom team template
Get a team template by ID
Get team templates
Save the naming settings
TFA settings
Generate setup code
Get confirmation email
Get confirmation email for updating TFA settings
Get the TFA codes
Get the TFA settings
Unlink the TFA application
Update the TFA codes
Update the TFA settings
Validate the TFA code
Tips
Check the tip subscription
Update the tip settings
Update the tip subscription
Webhooks
Create a webhook
Disable a webhook
Get webhook logs
Get webhook settings
Get webhooks
Remove a webhook
Retry a webhook
Retry webhooks
Update a webhook
API system
Basic concepts
Authentication
Portals
Get portals
Register portal
Portal deletion
Portal status
Validate portal name
Billing
Get tariff
Set tariff
More information
Changelog
FAQ
Filtering
Batching
Changelog
The list of changes for ONLYOFFICE DocSpace API.
Version 2.0
Updated
Storybook
.
Added the
Plugins SDK
section.