Skip to content

ONLYOFFICE/docspace-api-sdk-javascript

BranchesTags

Repository files navigation

@onlyoffice/docspace-api-sdk

The ONLYOFFICE DocSpace SDK for JavaScript is a library that provides tools for integrating and managing DocSpace features within your applications. It simplifies interaction with the DocSpace TypeScript API by offering ready-to-use methods and models.

  • API version: 3.2.0
  • SDK version: 1.0.0

For more information, please visit https://helpdesk.onlyoffice.com/hc/en-us

Installation

Using Node.js

npm

To publish the library as an npm package, please follow the instructions here.

To install the package, run:

npm install @onlyoffice/docspace-api-sdk --save

Finally, build the module:

npm run build
Local development

To use the library locally without publishing it to a remote npm registry:

  1. Navigate to the directory containing package.json (and this README.md file). Let's refer to this path as JAVASCRIPT_CLIENT_DIR.

  2. Install dependencies:

npm install
  1. Link the package globally:
npm link

  1. Switch to the directory you want to use your @onlyoffice/docspace-api-sdk from.

  2. To use the link defined in your project, run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
  1. Build the module:
npm run build

Git

If the library is hosted in a Git repository (e.g., https://github.com/ONLYOFFICE/docspace-api-sdk-javascript), you can install it directly:

    npm install git+https://github.com/ONLYOFFICE/docspace-api-sdk-javascript.git

Using browser

The library also works in the browser environment via npm and Browserify:

  1. Follow the instructions from the Using Node.js section.

  2. Install Browserify:

npm install -g browserify
  1. Assuming main.js is your entry file, bundle the code:
browserify main.js > bundle.js
  1. Include bundle.js in the HTML pages.

Webpack Configuration

When using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module". You should probably disable the AMD loader. Add/merge the following section to your Webpack configuration:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Documentation for Authorization

Authentication schemes defined for the API:

asc_auth_key

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

Basic

  • Type: HTTP basic authentication

Bearer

  • Type: Bearer authentication (JWT)

ApiKeyBearer

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

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: {{authBaseUrl}}/oauth2/authorize
  • Token Url: {{authBaseUrl}}/oauth2/token
  • Scopes:
    • read: Read access to protected resources
    • write: Write access to protected resources

OpenId

  • Type: OpenId Connect
  • OpenId Connect URL: {{authBaseUrl}}/.well-known/openid-configuration

x-signature

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

Getting Started

Please follow the installation instruction and execute the following JS code:

var Api = require('@onlyoffice/docspace-api-sdk');

var defaultClient = Api.ApiClient.instance;
// Configure HTTP basic authorization: Basic
var Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME'
Basic.password = 'YOUR PASSWORD'
// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN"
// Configure API key authorization: ApiKeyBearer
var ApiKeyBearer = defaultClient.authentications['ApiKeyBearer'];
ApiKeyBearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyBearer.apiKeyPrefix['ApiKeyBearer'] = "Token"
// Configure API key authorization: asc_auth_key
var asc_auth_key = defaultClient.authentications['asc_auth_key'];
asc_auth_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//asc_auth_key.apiKeyPrefix['asc_auth_key'] = "Token"
// Configure Bearer (JWT) access token for authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.accessToken = "YOUR ACCESS TOKEN"

var api = new Api.ApiKeysApi()
var opts = {
  'createApiKeyRequestDto': new Api.CreateApiKeyRequestDto() // {CreateApiKeyRequestDto} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApiKey(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8092

API Endoints table
Class Method HTTP request Description
Api.ApiKeysApi createApiKey POST /api/2.0/keys Create a user API key
Api.ApiKeysApi deleteApiKey DELETE /api/2.0/keys/{keyId} Delete a user API key
Api.ApiKeysApi getAllPermissions GET /api/2.0/keys/permissions Get API key permissions
Api.ApiKeysApi getApiKey GET /api/2.0/keys/@self Get user API key info
Api.ApiKeysApi getApiKeys GET /api/2.0/keys Get user API keys
Api.ApiKeysApi updateApiKey PUT /api/2.0/keys/{keyId} Update an API key
Api.AuthenticationApi authenticateMe POST /api/2.0/authentication Authenticate a user
Api.AuthenticationApi authenticateMeFromBodyWithCode POST /api/2.0/authentication/{code} Authenticate a user by code
Api.AuthenticationApi checkConfirm POST /api/2.0/authentication/confirm Open confirmation email URL
Api.AuthenticationApi getIsAuthentificated GET /api/2.0/authentication Check authentication
Api.AuthenticationApi logout POST /api/2.0/authentication/logout Log out
Api.AuthenticationApi saveMobilePhone POST /api/2.0/authentication/setphone Set a mobile phone
Api.AuthenticationApi sendSmsCode POST /api/2.0/authentication/sendsms Send SMS code
Api.BackupApi createBackupSchedule POST /api/2.0/backup/createbackupschedule Create the backup schedule
Api.BackupApi deleteBackup DELETE /api/2.0/backup/deletebackup/{id} Delete the backup
Api.BackupApi deleteBackupHistory DELETE /api/2.0/backup/deletebackuphistory Delete the backup history
Api.BackupApi deleteBackupSchedule DELETE /api/2.0/backup/deletebackupschedule Delete the backup schedule
Api.BackupApi getBackupHistory GET /api/2.0/backup/getbackuphistory Get the backup history
Api.BackupApi getBackupProgress GET /api/2.0/backup/getbackupprogress Get the backup progress
Api.BackupApi getBackupSchedule GET /api/2.0/backup/getbackupschedule Get the backup schedule
Api.BackupApi getRestoreProgress GET /api/2.0/backup/getrestoreprogress Get the restoring progress
Api.BackupApi startBackup POST /api/2.0/backup/startbackup Start the backup
Api.BackupApi startBackupRestore POST /api/2.0/backup/startrestore Start the restoring process
Api.CapabilitiesApi getPortalCapabilities GET /api/2.0/capabilities Get portal capabilities
Api.FilesFilesApi addTemplates POST /api/2.0/files/templates Add template files
Api.FilesFilesApi changeVersionHistory PUT /api/2.0/files/file/{fileId}/history Change version history
Api.FilesFilesApi checkFillFormDraft POST /api/2.0/files/masterform/{fileId}/checkfillformdraft Check the form draft filling
Api.FilesFilesApi copyFileAs POST /api/2.0/files/file/{fileId}/copyas Copy a file
Api.FilesFilesApi createEditSession POST /api/2.0/files/file/{fileId}/edit_session Create the editing session
Api.FilesFilesApi createFile POST /api/2.0/files/{folderId}/file Create a file
Api.FilesFilesApi createFileInMyDocuments POST /api/2.0/files/@my/file Create a file in the &quot;My documents&quot; section
Api.FilesFilesApi createHtmlFile POST /api/2.0/files/{folderId}/html Create an HTML file
Api.FilesFilesApi createHtmlFileInMyDocuments POST /api/2.0/files/@my/html Create an HTML file in the &quot;My documents&quot; section
Api.FilesFilesApi createPrimaryExternalLink POST /api/2.0/files/file/{id}/link Create primary external link
Api.FilesFilesApi createTextFile POST /api/2.0/files/{folderId}/text Create a text file
Api.FilesFilesApi createTextFileInMyDocuments POST /api/2.0/files/@my/text Create a text file in the &quot;My documents&quot; section
Api.FilesFilesApi createThumbnails POST /api/2.0/files/thumbnails Create file thumbnails
Api.FilesFilesApi deleteFile DELETE /api/2.0/files/file/{fileId} Delete a file
Api.FilesFilesApi deleteRecent DELETE /api/2.0/files/recent Delete recent files
Api.FilesFilesApi deleteTemplates DELETE /api/2.0/files/templates Delete template files
Api.FilesFilesApi getAllFormRoles GET /api/2.0/files/file/{fileId}/formroles Get form roles
Api.FilesFilesApi getEditDiffUrl GET /api/2.0/files/file/{fileId}/edit/diff Get changes URL
Api.FilesFilesApi getEditHistory GET /api/2.0/files/file/{fileId}/edit/history Get version history
Api.FilesFilesApi getFileHistory GET /api/2.0/files/file/{fileId}/log Get file history
Api.FilesFilesApi getFileInfo GET /api/2.0/files/file/{fileId} Get file information
Api.FilesFilesApi getFileLinks GET /api/2.0/files/file/{id}/links Get file external links
Api.FilesFilesApi getFilePrimaryExternalLink GET /api/2.0/files/file/{id}/link Get primary external link
Api.FilesFilesApi getFileVersionInfo GET /api/2.0/files/file/{fileId}/history Get file versions
Api.FilesFilesApi getFillResult GET /api/2.0/files/file/fillresult Get form-filling result
Api.FilesFilesApi getPresignedFileUri GET /api/2.0/files/file/{fileId}/presigned Get file download link asynchronously
Api.FilesFilesApi getPresignedUri GET /api/2.0/files/file/{fileId}/presigneduri Get file download link
Api.FilesFilesApi getProtectedFileUsers GET /api/2.0/files/file/{fileId}/protectusers Get users access rights to the protected file
Api.FilesFilesApi getReferenceData POST /api/2.0/files/file/referencedata Get reference data
Api.FilesFilesApi isFormPDF GET /api/2.0/files/file/{fileId}/isformpdf Check the PDF file
Api.FilesFilesApi lockFile PUT /api/2.0/files/file/{fileId}/lock Lock a file
Api.FilesFilesApi manageFormFilling PUT /api/2.0/files/file/{fileId}/manageformfilling Perform form filling action
Api.FilesFilesApi openEditFile GET /api/2.0/files/file/{fileId}/openedit Open a file configuration
Api.FilesFilesApi restoreFileVersion GET /api/2.0/files/file/{fileId}/restoreversion Restore a file version
Api.FilesFilesApi saveEditingFileFromForm PUT /api/2.0/files/file/{fileId}/saveediting Save file edits
Api.FilesFilesApi saveFileAsPdf POST /api/2.0/files/file/{id}/saveaspdf Save a file as PDF
Api.FilesFilesApi saveFormRoleMapping POST /api/2.0/files/file/{fileId}/formrolemapping Save form role mapping
Api.FilesFilesApi setCustomFilterTag PUT /api/2.0/files/file/{fileId}/customfilter Set the Custom Filter editing mode
Api.FilesFilesApi setExternalLink PUT /api/2.0/files/file/{id}/links Set an external link
Api.FilesFilesApi setFileOrder PUT /api/2.0/files/{fileId}/order Set file order
Api.FilesFilesApi setFilesOrder PUT /api/2.0/files/order Set order of files
Api.FilesFilesApi startEditFile POST /api/2.0/files/file/{fileId}/startedit Start file editing
Api.FilesFilesApi startFillingFile PUT /api/2.0/files/file/{fileId}/startfilling Start file filling
Api.FilesFilesApi trackEditFile GET /api/2.0/files/file/{fileId}/trackeditfile Track file editing
Api.FilesFilesApi updateFile PUT /api/2.0/files/file/{fileId} Update a file
Api.FilesFoldersApi checkUpload POST /api/2.0/files/{folderId}/upload/check Check file uploads
Api.FilesFoldersApi createFolder POST /api/2.0/files/folder/{folderId} Create a folder
Api.FilesFoldersApi deleteFolder DELETE /api/2.0/files/folder/{folderId} Delete a folder
Api.FilesFoldersApi getFilesUsedSpace GET /api/2.0/files/filesusedspace Get used space of files
Api.FilesFoldersApi getFolder GET /api/2.0/files/{folderId}/formfilter Get folder form filter
Api.FilesFoldersApi getFolderByFolderId GET /api/2.0/files/{folderId} Get a folder by ID
Api.FilesFoldersApi getFolderHistory GET /api/2.0/files/folder/{folderId}/log Get folder history
Api.FilesFoldersApi getFolderInfo GET /api/2.0/files/folder/{folderId} Get folder information
Api.FilesFoldersApi getFolderPath GET /api/2.0/files/folder/{folderId}/path Get the folder path
Api.FilesFoldersApi getFolderPrimaryExternalLink GET /api/2.0/files/folder/{id}/link Get primary external link
Api.FilesFoldersApi getFolders GET /api/2.0/files/{folderId}/subfolders Get subfolders
Api.FilesFoldersApi getMyFolder GET /api/2.0/files/@my Get the &quot;My documents&quot; section
Api.FilesFoldersApi getNewFolderItems GET /api/2.0/files/{folderId}/news Get new folder items
Api.FilesFoldersApi getPrivacyFolder GET /api/2.0/files/@privacy Get the &quot;Private Room&quot; section
Api.FilesFoldersApi getRootFolders GET /api/2.0/files/@root Get filtered sections
Api.FilesFoldersApi getTrashFolder GET /api/2.0/files/@trash Get the &quot;Trash&quot; section
Api.FilesFoldersApi insertFile POST /api/2.0/files/{folderId}/insert Insert a file
Api.FilesFoldersApi insertFileToMyFromBody POST /api/2.0/files/@my/insert Insert a file to the &quot;My documents&quot; section
Api.FilesFoldersApi renameFolder PUT /api/2.0/files/folder/{folderId} Rename a folder
Api.FilesFoldersApi setFolderOrder PUT /api/2.0/files/folder/{folderId}/order Set folder order
Api.FilesFoldersApi uploadFile POST /api/2.0/files/{folderId}/upload Upload a file
Api.FilesFoldersApi uploadFileToMy POST /api/2.0/files/@my/upload Upload a file to the &quot;My documents&quot; section
Api.FilesOperationsApi bulkDownload PUT /api/2.0/files/fileops/bulkdownload Bulk download
Api.FilesOperationsApi checkConversionStatus GET /api/2.0/files/file/{fileId}/checkconversion Get conversion status
Api.FilesOperationsApi checkMoveOrCopyBatchItems GET /api/2.0/files/fileops/move Check and move or copy to a folder
Api.FilesOperationsApi checkMoveOrCopyDestFolder GET /api/2.0/files/fileops/checkdestfolder Check for moving or copying to a folder
Api.FilesOperationsApi copyBatchItems PUT /api/2.0/files/fileops/copy Copy to the folder
Api.FilesOperationsApi createUploadSession POST /api/2.0/files/{folderId}/upload/create_session Chunked upload
Api.FilesOperationsApi deleteBatchItems PUT /api/2.0/files/fileops/delete Delete files and folders
Api.FilesOperationsApi deleteFileVersions PUT /api/2.0/files/fileops/deleteversion Delete file versions
Api.FilesOperationsApi duplicateBatchItems PUT /api/2.0/files/fileops/duplicate Duplicate files and folders
Api.FilesOperationsApi emptyTrash PUT /api/2.0/files/fileops/emptytrash Empty the &quot;Trash&quot; folder
Api.FilesOperationsApi getOperationStatuses GET /api/2.0/files/fileops Get active file operations
Api.FilesOperationsApi getOperationStatusesByType GET /api/2.0/files/fileops/{operationType} Get file operation statuses
Api.FilesOperationsApi markAsRead PUT /api/2.0/files/fileops/markasread Mark as read
Api.FilesOperationsApi moveBatchItems PUT /api/2.0/files/fileops/move Move or copy to a folder
Api.FilesOperationsApi startFileConversion PUT /api/2.0/files/file/{fileId}/checkconversion Start file conversion
Api.FilesOperationsApi terminateTasks PUT /api/2.0/files/fileops/terminate/{id} Finish active operations
Api.FilesOperationsApi updateFileComment PUT /api/2.0/files/file/{fileId}/comment Update a comment
Api.FilesQuotaApi resetRoomQuota PUT /api/2.0/files/rooms/resetquota Reset the room quota limit
Api.FilesQuotaApi updateRoomsQuota PUT /api/2.0/files/rooms/roomquota Change the room quota limit
Api.FilesSettingsApi changeAccessToThirdparty PUT /api/2.0/files/thirdparty Change the third-party settings access
Api.FilesSettingsApi changeAutomaticallyCleanUp PUT /api/2.0/files/settings/autocleanup Update the trash bin auto-clearing setting
Api.FilesSettingsApi changeDefaultAccessRights PUT /api/2.0/files/settings/dafaultaccessrights Change the default access rights
Api.FilesSettingsApi changeDeleteConfirm PUT /api/2.0/files/changedeleteconfrim Confirm the file deletion
Api.FilesSettingsApi changeDownloadZipFromBody PUT /api/2.0/files/settings/downloadtargz Change the archive format (using body parameters)
Api.FilesSettingsApi checkDocServiceUrl PUT /api/2.0/files/docservice Check the document service URL
Api.FilesSettingsApi displayFileExtension PUT /api/2.0/files/displayfileextension Display a file extension
Api.FilesSettingsApi externalShare PUT /api/2.0/files/settings/external Change the external sharing ability
Api.FilesSettingsApi externalShareSocialMedia PUT /api/2.0/files/settings/externalsocialmedia Change the external sharing ability on social networks
Api.FilesSettingsApi forcesave PUT /api/2.0/files/forcesave Change the forcesaving ability
Api.FilesSettingsApi getAutomaticallyCleanUp GET /api/2.0/files/settings/autocleanup Get the trash bin auto-clearing setting
Api.FilesSettingsApi getDocServiceUrl GET /api/2.0/files/docservice Get the document service URL
Api.FilesSettingsApi getFilesModule GET /api/2.0/files/info Get the &quot;Documents&quot; information
Api.FilesSettingsApi getFilesSettings GET /api/2.0/files/settings Get file settings
Api.FilesSettingsApi hideConfirmCancelOperation PUT /api/2.0/files/hideconfirmcanceloperation Hide confirmation dialog when canceling operations
Api.FilesSettingsApi hideConfirmConvert PUT /api/2.0/files/hideconfirmconvert Hide the confirmation dialog when converting
Api.FilesSettingsApi hideConfirmRoomLifetime PUT /api/2.0/files/hideconfirmroomlifetime Hide confirmation dialog when changing room lifetime settings
Api.FilesSettingsApi isAvailablePrivacyRoomSettings GET /api/2.0/files/@privacy/available Check the &quot;Private Room&quot; availability
Api.FilesSettingsApi keepNewFileName PUT /api/2.0/files/keepnewfilename Ask a new file name
Api.FilesSettingsApi setOpenEditorInSameTab PUT /api/2.0/files/settings/openeditorinsametab Open document in the same browser tab
Api.FilesSettingsApi storeForcesave PUT /api/2.0/files/storeforcesave Change the ability to store the forcesaved files
Api.FilesSettingsApi storeOriginal PUT /api/2.0/files/storeoriginal Change the ability to upload original formats
Api.FilesSettingsApi updateFileIfExist PUT /api/2.0/files/updateifexist Update a file version if it exists
Api.FilesSharingApi applyExternalSharePassword POST /api/2.0/files/share/{key}/password Apply external data password
Api.FilesSharingApi changeFileOwner POST /api/2.0/files/owner Change the file owner
Api.FilesSharingApi getExternalShareData GET /api/2.0/files/share/{key} Get the external data
Api.FilesSharingApi getSharedUsers GET /api/2.0/files/file/{fileId}/sharedusers Get user access rights by file ID
Api.FilesSharingApi sendEditorNotify POST /api/2.0/files/file/{fileId}/sendeditornotify Send the mention message
Api.FilesThirdPartyIntegrationApi deleteThirdParty DELETE /api/2.0/files/thirdparty/{providerId} Remove a third-party account
Api.FilesThirdPartyIntegrationApi getAllProviders GET /api/2.0/files/thirdparty/providers Get all providers
Api.FilesThirdPartyIntegrationApi getBackupThirdPartyAccount GET /api/2.0/files/thirdparty/backup Get a third-party account backup
Api.FilesThirdPartyIntegrationApi getCapabilities GET /api/2.0/files/thirdparty/capabilities Get providers
Api.FilesThirdPartyIntegrationApi getCommonThirdPartyFolders GET /api/2.0/files/thirdparty/common Get the common third-party services
Api.FilesThirdPartyIntegrationApi getThirdPartyAccounts GET /api/2.0/files/thirdparty Get the third-party accounts
Api.FilesThirdPartyIntegrationApi saveThirdParty POST /api/2.0/files/thirdparty Save a third-party account
Api.FilesThirdPartyIntegrationApi saveThirdPartyBackup POST /api/2.0/files/thirdparty/backup Save a third-party account backup
Api.GroupApi addGroup POST /api/2.0/group Add a new group
Api.GroupApi addMembersTo PUT /api/2.0/group/{id}/members Add group members
Api.GroupApi deleteGroup DELETE /api/2.0/group/{id} Delete a group
Api.GroupApi getGroup GET /api/2.0/group/{id} Get a group
Api.GroupApi getGroupByUserId GET /api/2.0/group/user/{userid} Get user groups
Api.GroupApi getGroups GET /api/2.0/group Get groups
Api.GroupApi moveMembersTo PUT /api/2.0/group/{fromId}/members/{toId} Move group members
Api.GroupApi removeMembersFrom DELETE /api/2.0/group/{id}/members Remove group members
Api.GroupApi setGroupManager PUT /api/2.0/group/{id}/manager Set a group manager
Api.GroupApi setMembersTo POST /api/2.0/group/{id}/members Replace group members
Api.GroupApi updateGroup PUT /api/2.0/group/{id} Update a group
Api.GroupRoomsApi getGroupsWithShared GET /api/2.0/group/room/{id} Get groups with sharing settings
Api.MigrationApi cancelMigration POST /api/2.0/migration/cancel Cancel migration
Api.MigrationApi clearMigration POST /api/2.0/migration/clear Clear migration
Api.MigrationApi finishMigration POST /api/2.0/migration/finish Finish migration
Api.MigrationApi getMigrationLogs GET /api/2.0/migration/logs Get migration logs
Api.MigrationApi getMigrationStatus GET /api/2.0/migration/status Get migration status
Api.MigrationApi listMigrations GET /api/2.0/migration/list Get migrations
Api.MigrationApi startMigration POST /api/2.0/migration/migrate Start migration
Api.MigrationApi uploadAndInitializeMigration POST /api/2.0/migration/init/{migratorName} Upload and initialize migration
Api.OAuth20AuthorizationApi authorizeOAuth GET /oauth2/authorize OAuth2 authorization endpoint
Api.OAuth20AuthorizationApi exchangeToken POST /oauth2/token OAuth2 token endpoint
Api.OAuth20AuthorizationApi submitConsent POST /oauth2/authorize OAuth2 consent endpoint
Api.OAuth20ClientManagementApi changeActivation PATCH /api/2.0/clients/{clientId}/activation Change the client activation status
Api.OAuth20ClientManagementApi createClient POST /api/2.0/clients Create a new OAuth2 client
Api.OAuth20ClientManagementApi deleteClient DELETE /api/2.0/clients/{clientId} Delete an OAuth2 client
Api.OAuth20ClientManagementApi regenerateSecret PATCH /api/2.0/clients/{clientId}/regenerate Regenerate the client secret
Api.OAuth20ClientManagementApi revokeUserClient DELETE /api/2.0/clients/{clientId}/revoke Revoke client consent
Api.OAuth20ClientManagementApi updateClient PUT /api/2.0/clients/{clientId} Update an existing OAuth2 client
Api.OAuth20ClientQueryingApi getClient GET /api/2.0/clients/{clientId} Get client details
Api.OAuth20ClientQueryingApi getClientInfo GET /api/2.0/clients/{clientId}/info Get detailed client information
Api.OAuth20ClientQueryingApi getClients GET /api/2.0/clients Get clients
Api.OAuth20ClientQueryingApi getClientsInfo GET /api/2.0/clients/info Get detailed information of clients
Api.OAuth20ClientQueryingApi getConsents GET /api/2.0/clients/consents Get user consents
Api.OAuth20ClientQueryingApi getPublicClientInfo GET /api/2.0/clients/{clientId}/public/info Get public client information
Api.OAuth20ScopeManagementApi getScopes GET /api/2.0/scopes Get available OAuth2 scopes
Api.PeopleGuestsApi approveGuestShareLink POST /api/2.0/people/guests/share/approve Approve a guest sharing link
Api.PeopleGuestsApi deleteGuests DELETE /api/2.0/people/guests Delete guests
Api.PeoplePasswordApi changeUserPassword PUT /api/2.0/people/{userid}/password Change a user password
Api.PeoplePasswordApi sendUserPassword POST /api/2.0/people/password Remind a user password
Api.PeoplePhotosApi createMemberPhotoThumbnails POST /api/2.0/people/{userid}/photo/thumbnails Create photo thumbnails
Api.PeoplePhotosApi deleteMemberPhoto DELETE /api/2.0/people/{userid}/photo Delete a user photo
Api.PeoplePhotosApi getMemberPhoto GET /api/2.0/people/{userid}/photo Get a user photo
Api.PeoplePhotosApi updateMemberPhoto PUT /api/2.0/people/{userid}/photo Update a user photo
Api.PeoplePhotosApi uploadMemberPhoto POST /api/2.0/people/{userid}/photo Upload a user photo
Api.PeopleProfilesApi addMember POST /api/2.0/people Add a user
Api.PeopleProfilesApi deleteMember DELETE /api/2.0/people/{userid} Delete a user
Api.PeopleProfilesApi deleteProfile DELETE /api/2.0/people/@self Delete my profile
Api.PeopleProfilesApi getAllProfiles GET /api/2.0/people Get profiles
Api.PeopleProfilesApi getClaims GET /api/2.0/people/tokendiagnostics Returns the user claims.
Api.PeopleProfilesApi getProfileByEmail GET /api/2.0/people/email Get a profile by user email
Api.PeopleProfilesApi getProfileByUserId GET /api/2.0/people/{userid} Get a profile by user name
Api.PeopleProfilesApi getSelfProfile GET /api/2.0/people/@self Get my profile
Api.PeopleProfilesApi inviteUsers POST /api/2.0/people/invite Invite users
Api.PeopleProfilesApi removeUsers PUT /api/2.0/people/delete Delete users
Api.PeopleProfilesApi resendUserInvites PUT /api/2.0/people/invite Resend activation emails
Api.PeopleProfilesApi sendEmailChangeInstructions POST /api/2.0/people/email Send instructions to change email
Api.PeopleProfilesApi updateMember PUT /api/2.0/people/{userid} Update a user
Api.PeopleProfilesApi updateMemberCulture PUT /api/2.0/people/{userid}/culture Update a user culture code
Api.PeopleQuotaApi resetUsersQuota PUT /api/2.0/people/resetquota Reset a user quota limit
Api.PeopleQuotaApi updateUserQuota PUT /api/2.0/people/userquota Change a user quota limit
Api.PeopleSearchApi getAccountsEntriesWithShared GET /api/2.0/accounts/room/{id}/search Get account entries
Api.PeopleSearchApi getSearch GET /api/2.0/people/@search/{query} Search users
Api.PeopleSearchApi getSimpleByFilter GET /api/2.0/people/simple/filter Search users by extended filter
Api.PeopleSearchApi getUsersWithRoomShared GET /api/2.0/people/room/{id} Get users with room sharing settings
Api.PeopleSearchApi searchUsersByExtendedFilter GET /api/2.0/people/filter Search users with detaailed information by extended filter
Api.PeopleSearchApi searchUsersByQuery GET /api/2.0/people/search Search users (using query parameters)
Api.PeopleSearchApi searchUsersByStatus GET /api/2.0/people/status/{status}/search Search users by status filter
Api.PeopleThemeApi changePortalTheme PUT /api/2.0/people/theme Change the portal theme
Api.PeopleThemeApi getPortalTheme GET /api/2.0/people/theme Get the portal theme
Api.PeopleThirdPartyAccountsApi getThirdPartyAuthProviders GET /api/2.0/people/thirdparty/providers Get third-party accounts
Api.PeopleThirdPartyAccountsApi linkThirdPartyAccount PUT /api/2.0/people/thirdparty/linkaccount Link a third-pary account
Api.PeopleThirdPartyAccountsApi signupThirdPartyAccount POST /api/2.0/people/thirdparty/signup Create a third-pary account
Api.PeopleThirdPartyAccountsApi unlinkThirdPartyAccount DELETE /api/2.0/people/thirdparty/unlinkaccount Unlink a third-pary account
Api.PeopleUserDataApi getDeletePersonalFolderProgress GET /api/2.0/people/delete/personal/progress Get the progress of deleting the personal folder
Api.PeopleUserDataApi getReassignProgress GET /api/2.0/people/reassign/progress/{userid} Get the reassignment progress
Api.PeopleUserDataApi getRemoveProgress GET /api/2.0/people/remove/progress/{userid} Get the deletion progress
Api.PeopleUserDataApi necessaryReassign GET /api/2.0/people/reassign/necessary Check the data reassignment need
Api.PeopleUserDataApi sendInstructionsToDelete PUT /api/2.0/people/self/delete Send the deletion instructions
Api.PeopleUserDataApi startDeletePersonalFolder POST /api/2.0/people/delete/personal/start Delete the personal folder
Api.PeopleUserDataApi startReassign POST /api/2.0/people/reassign/start Start the data reassignment
Api.PeopleUserDataApi startRemove POST /api/2.0/people/remove/start Start the data deletion
Api.PeopleUserDataApi terminateReassign PUT /api/2.0/people/reassign/terminate Terminate the data reassignment
Api.PeopleUserDataApi terminateRemove PUT /api/2.0/people/remove/terminate Terminate the data deletion
Api.PeopleUserStatusApi getByStatus GET /api/2.0/people/status/{status} Get profiles by status
Api.PeopleUserStatusApi updateUserActivationStatus PUT /api/2.0/people/activationstatus/{activationstatus} Set an activation status to the users
Api.PeopleUserStatusApi updateUserStatus PUT /api/2.0/people/status/{status} Change a user status
Api.PeopleUserTypeApi getUserTypeUpdateProgress GET /api/2.0/people/type/progress/{userid} Get the progress of updating user type
Api.PeopleUserTypeApi starUserTypetUpdate POST /api/2.0/people/type Update user type
Api.PeopleUserTypeApi terminateUserTypeUpdate PUT /api/2.0/people/type/terminate Terminate update user type
Api.PeopleUserTypeApi updateUserType PUT /api/2.0/people/type/{type} Change a user type
Api.PortalGuestsApi getGuestSharingLink GET /api/2.0/people/guests/{userid}/share Get a guest sharing link
Api.PortalPaymentApi calculateWalletPayment PUT /api/2.0/portal/payment/calculatewallet Calculate amount of the wallet payment
Api.PortalPaymentApi createCustomerOperationsReport POST /api/2.0/portal/payment/customer/operationsreport Generate the customer operations report
Api.PortalPaymentApi getCheckoutSetupUrl GET /api/2.0/portal/payment/chechoutsetupurl Get the checkout setup page URL
Api.PortalPaymentApi getCustomerBalance GET /api/2.0/portal/payment/customer/balance Get the customer balance
Api.PortalPaymentApi getCustomerInfo GET /api/2.0/portal/payment/customerinfo Get the customer info
Api.PortalPaymentApi getCustomerOperations GET /api/2.0/portal/payment/customer/operations Get the customer operations
Api.PortalPaymentApi getPaymentAccount GET /api/2.0/portal/payment/account Get the payment account
Api.PortalPaymentApi getPaymentCurrencies GET /api/2.0/portal/payment/currencies Get currencies
Api.PortalPaymentApi getPaymentQuotas GET /api/2.0/portal/payment/quotas Get quotas
Api.PortalPaymentApi getPaymentUrl PUT /api/2.0/portal/payment/url Get the payment page URL
Api.PortalPaymentApi getPortalPrices GET /api/2.0/portal/payment/prices Get prices
Api.PortalPaymentApi getQuotaPaymentInformation GET /api/2.0/portal/payment/quota Get quota payment information
Api.PortalPaymentApi getTenantWalletSettings GET /api/2.0/portal/payment/topupsettings Get wallet auto top up settings
Api.PortalPaymentApi sendPaymentRequest POST /api/2.0/portal/payment/request Send a payment request
Api.PortalPaymentApi setTenantWalletSettings POST /api/2.0/portal/payment/topupsettings Set wallet auto top up settings
Api.PortalPaymentApi topUpDeposit POST /api/2.0/portal/payment/deposit Put money on deposit
Api.PortalPaymentApi updatePayment PUT /api/2.0/portal/payment/update Update the payment quantity
Api.PortalPaymentApi updateWalletPayment PUT /api/2.0/portal/payment/updatewallet Update the wallet payment quantity
Api.PortalQuotaApi getPortalQuota GET /api/2.0/portal/quota Get a portal quota
Api.PortalQuotaApi getPortalTariff GET /api/2.0/portal/tariff Get a portal tariff
Api.PortalQuotaApi getPortalUsedSpace GET /api/2.0/portal/usedspace Get the portal used space
Api.PortalQuotaApi getRightQuota GET /api/2.0/portal/quota/right Get the recommended quota
Api.PortalSettingsApi continuePortal PUT /api/2.0/portal/continue Restore a portal
Api.PortalSettingsApi deletePortal DELETE /api/2.0/portal/delete Delete a portal
Api.PortalSettingsApi getPortalInformation GET /api/2.0/portal Get a portal
Api.PortalSettingsApi getPortalPath GET /api/2.0/portal/path Get a path to the portal
Api.PortalSettingsApi sendDeleteInstructions POST /api/2.0/portal/delete Send removal instructions
Api.PortalSettingsApi sendSuspendInstructions POST /api/2.0/portal/suspend Send suspension instructions
Api.PortalSettingsApi suspendPortal PUT /api/2.0/portal/suspend Deactivate a portal
Api.PortalUsersApi getInvitationLink GET /api/2.0/portal/users/invite/{employeeType} Get an invitation link
Api.PortalUsersApi getPortalUsersCount GET /api/2.0/portal/userscount Get a number of portal users
Api.PortalUsersApi getUserById GET /api/2.0/portal/users/{userID} Get a user by ID
Api.PortalUsersApi markGiftMessageAsRead POST /api/2.0/portal/present/mark Mark a gift message as read
Api.PortalUsersApi sendCongratulations POST /api/2.0/portal/sendcongratulations Send congratulations
Api.RoomsApi addRoomTags PUT /api/2.0/files/rooms/{id}/tags Add the room tags
Api.RoomsApi archiveRoom PUT /api/2.0/files/rooms/{id}/archive Archive a room
Api.RoomsApi changeRoomCover POST /api/2.0/files/rooms/{id}/cover Change the room cover
Api.RoomsApi createRoom POST /api/2.0/files/rooms Create a room
Api.RoomsApi createRoomFromTemplate POST /api/2.0/files/rooms/fromtemplate Create a room from the template
Api.RoomsApi createRoomLogo POST /api/2.0/files/rooms/{id}/logo Create a room logo
Api.RoomsApi createRoomTag POST /api/2.0/files/tags Create a tag
Api.RoomsApi createRoomTemplate POST /api/2.0/files/roomtemplate Start creating room template
Api.RoomsApi createRoomThirdParty POST /api/2.0/files/rooms/thirdparty/{id} Create a third-party room
Api.RoomsApi deleteCustomTags DELETE /api/2.0/files/tags Delete tags
Api.RoomsApi deleteRoom DELETE /api/2.0/files/rooms/{id} Remove a room
Api.RoomsApi deleteRoomLogo DELETE /api/2.0/files/rooms/{id}/logo Remove a room logo
Api.RoomsApi deleteRoomTags DELETE /api/2.0/files/rooms/{id}/tags Remove the room tags
Api.RoomsApi getNewRoomItems GET /api/2.0/files/rooms/{id}/news Get the new room items
Api.RoomsApi getPublicSettings GET /api/2.0/files/roomtemplate/{id}/public Get public settings
Api.RoomsApi getRoomCovers GET /api/2.0/files/rooms/covers Get covers
Api.RoomsApi getRoomCreatingStatus GET /api/2.0/files/rooms/fromtemplate/status Get the room creation progress
Api.RoomsApi getRoomIndexExport GET /api/2.0/files/rooms/indexexport Get the room index export
Api.RoomsApi getRoomInfo GET /api/2.0/files/rooms/{id} Get room information
Api.RoomsApi getRoomLinks GET /api/2.0/files/rooms/{id}/links Get the room links
Api.RoomsApi getRoomSecurityInfo GET /api/2.0/files/rooms/{id}/share Get the room access rights
Api.RoomsApi getRoomTagsInfo GET /api/2.0/files/tags Get tags
Api.RoomsApi getRoomTemplateCreatingStatus GET /api/2.0/files/roomtemplate/status Get status of room template creation
Api.RoomsApi getRoomsFolder GET /api/2.0/files/rooms Get rooms
Api.RoomsApi getRoomsNewItems GET /api/2.0/files/rooms/news Get the room new items
Api.RoomsApi getRoomsPrimaryExternalLink GET /api/2.0/files/rooms/{id}/link Get the room primary external link
Api.RoomsApi pinRoom PUT /api/2.0/files/rooms/{id}/pin Pin a room
Api.RoomsApi reorderRoom PUT /api/2.0/files/rooms/{id}/reorder Reorder the room
Api.RoomsApi resendEmailInvitations POST /api/2.0/files/rooms/{id}/resend Resend the room invitations
Api.RoomsApi setPublicSettings PUT /api/2.0/files/roomtemplate/public Set public settings
Api.RoomsApi setRoomLink PUT /api/2.0/files/rooms/{id}/links Set the room external or invitation link
Api.RoomsApi setRoomSecurity PUT /api/2.0/files/rooms/{id}/share Set the room access rights
Api.RoomsApi startRoomIndexExport POST /api/2.0/files/rooms/{id}/indexexport Start the room index export
Api.RoomsApi terminateRoomIndexExport DELETE /api/2.0/files/rooms/indexexport Terminate the room index export
Api.RoomsApi unarchiveRoom PUT /api/2.0/files/rooms/{id}/unarchive Unarchive a room
Api.RoomsApi unpinRoom PUT /api/2.0/files/rooms/{id}/unpin Unpin a room
Api.RoomsApi updateRoom PUT /api/2.0/files/rooms/{id} Update a room
Api.RoomsApi uploadRoomLogo POST /api/2.0/files/logos Upload a room logo image
Api.SecurityAccessToDevToolsApi setTenantDevToolsAccessSettings POST /api/2.0/settings/devtoolsaccess Set the Developer Tools access settings
Api.SecurityActiveConnectionsApi getAllActiveConnections GET /api/2.0/security/activeconnections Get active connections
Api.SecurityActiveConnectionsApi logOutActiveConnection PUT /api/2.0/security/activeconnections/logout/{loginEventId} Log out from the connection
Api.SecurityActiveConnectionsApi logOutAllActiveConnectionsChangePassword PUT /api/2.0/security/activeconnections/logoutallchangepassword Log out and change password
Api.SecurityActiveConnectionsApi logOutAllActiveConnectionsForUser PUT /api/2.0/security/activeconnections/logoutall/{userId} Log out for the user by ID
Api.SecurityActiveConnectionsApi logOutAllExceptThisConnection PUT /api/2.0/security/activeconnections/logoutallexceptthis Log out from all connections except the current one
Api.SecurityAuditTrailDataApi createAuditTrailReport POST /api/2.0/security/audit/events/report Generate the audit trail report
Api.SecurityAuditTrailDataApi getAuditEventsByFilter GET /api/2.0/security/audit/events/filter Get filtered audit trail data
Api.SecurityAuditTrailDataApi getAuditSettings GET /api/2.0/security/audit/settings/lifetime Get the audit trail settings
Api.SecurityAuditTrailDataApi getAuditTrailMappers GET /api/2.0/security/audit/mappers Get audit trail mappers
Api.SecurityAuditTrailDataApi getAuditTrailTypes GET /api/2.0/security/audit/types Get audit trail types
Api.SecurityAuditTrailDataApi getLastAuditEvents GET /api/2.0/security/audit/events/last Get audit trail data
Api.SecurityAuditTrailDataApi setAuditSettings POST /api/2.0/security/audit/settings/lifetime Set the audit trail settings
Api.SecurityBannersVisibilityApi setTenantBannerSettings POST /api/2.0/settings/banner Set the promotional banners visibility settings
Api.SecurityCSPApi configureCsp POST /api/2.0/security/csp Configure CSP settings
Api.SecurityCSPApi getCspSettings GET /api/2.0/security/csp Get CSP settings
Api.SecurityFirebaseApi docRegisterPusnNotificationDevice POST /api/2.0/settings/push/docregisterdevice Save the Documents Firebase device token
Api.SecurityFirebaseApi subscribeDocumentsPushNotification PUT /api/2.0/settings/push/docsubscribe Subscribe to Documents push notification
Api.SecurityLoginHistoryApi createLoginHistoryReport POST /api/2.0/security/audit/login/report Generate the login history report
Api.SecurityLoginHistoryApi getLastLoginEvents GET /api/2.0/security/audit/login/last Get login history
Api.SecurityLoginHistoryApi getLoginEventsByFilter GET /api/2.0/security/audit/login/filter Get filtered login events
Api.SecurityOAuth2Api generateJwtToken GET /api/2.0/security/oauth2/token Generate JWT token
Api.SecuritySMTPSettingsApi getSmtpOperationStatus GET /api/2.0/smtpsettings/smtp/test/status Get the SMTP testing process status
Api.SecuritySMTPSettingsApi getSmtpSettings GET /api/2.0/smtpsettings/smtp Get the SMTP settings
Api.SecuritySMTPSettingsApi resetSmtpSettings DELETE /api/2.0/smtpsettings/smtp Reset the SMTP settings
Api.SecuritySMTPSettingsApi saveSmtpSettings POST /api/2.0/smtpsettings/smtp Save the SMTP settings
Api.SecuritySMTPSettingsApi testSmtpSettings GET /api/2.0/smtpsettings/smtp/test Test the SMTP settings
Api.SettingsAccessToDevToolsApi getTenantAccessDevToolsSettings GET /api/2.0/settings/devtoolsaccess Get the Developer Tools access settings
Api.SettingsAuthorizationApi getAuthServices GET /api/2.0/settings/authservice Get the authorization services
Api.SettingsAuthorizationApi saveAuthKeys POST /api/2.0/settings/authservice Save the authorization keys
Api.SettingsBannersVisibilityApi getTenantBannerSettings GET /api/2.0/settings/banner Get the promotional banners visibility settings
Api.SettingsCommonSettingsApi closeAdminHelper PUT /api/2.0/settings/closeadminhelper Close the admin helper
Api.SettingsCommonSettingsApi completeWizard PUT /api/2.0/settings/wizard/complete Complete the Wizard settings
Api.SettingsCommonSettingsApi configureDeepLink POST /api/2.0/settings/deeplink Configure the deep link settings
Api.SettingsCommonSettingsApi deletePortalColorTheme DELETE /api/2.0/settings/colortheme Delete a color theme
Api.SettingsCommonSettingsApi getDeepLinkSettings GET /api/2.0/settings/deeplink Get the deep link settings
Api.SettingsCommonSettingsApi getPaymentSettings GET /api/2.0/settings/payment Get the payment settings
Api.SettingsCommonSettingsApi getPortalColorTheme GET /api/2.0/settings/colortheme Get a color theme
Api.SettingsCommonSettingsApi getPortalHostname GET /api/2.0/settings/machine Get hostname
Api.SettingsCommonSettingsApi getPortalLogo GET /api/2.0/settings/logo Get a portal logo
Api.SettingsCommonSettingsApi getPortalSettings GET /api/2.0/settings Get the portal settings
Api.SettingsCommonSettingsApi getSocketSettings GET /api/2.0/settings/socket Get the socket settings
Api.SettingsCommonSettingsApi getSupportedCultures GET /api/2.0/settings/cultures Get supported languages
Api.SettingsCommonSettingsApi getTenantUserInvitationSettings GET /api/2.0/settings/invitationsettings Get the user invitation settings
Api.SettingsCommonSettingsApi getTimeZones GET /api/2.0/settings/timezones Get time zones
Api.SettingsCommonSettingsApi saveDnsSettings PUT /api/2.0/settings/dns Save the DNS settings
Api.SettingsCommonSettingsApi saveMailDomainSettings POST /api/2.0/settings/maildomainsettings Save the mail domain settings
Api.SettingsCommonSettingsApi savePortalColorTheme PUT /api/2.0/settings/colortheme Save a color theme
Api.SettingsCommonSettingsApi updateEmailActivationSettings PUT /api/2.0/settings/emailactivation Update the email activation settings
Api.SettingsCommonSettingsApi updateInvitationSettings PUT /api/2.0/settings/invitationsettings Update user invitation settings
Api.SettingsCookiesApi getCookieSettings GET /api/2.0/settings/cookiesettings Get cookies lifetime
Api.SettingsCookiesApi updateCookieSettings PUT /api/2.0/settings/cookiesettings Update cookies lifetime
Api.SettingsCustomNavigationApi createCustomNavigationItem POST /api/2.0/settings/customnavigation/create Add a custom navigation item
Api.SettingsCustomNavigationApi deleteCustomNavigationItem DELETE /api/2.0/settings/customnavigation/delete/{id} Delete a custom navigation item
Api.SettingsCustomNavigationApi getCustomNavigationItem GET /api/2.0/settings/customnavigation/get/{id} Get a custom navigation item by ID
Api.SettingsCustomNavigationApi getCustomNavigationItemSample GET /api/2.0/settings/customnavigation/getsample Get a custom navigation item sample
Api.SettingsCustomNavigationApi getCustomNavigationItems GET /api/2.0/settings/customnavigation/getall Get the custom navigation items
Api.SettingsEncryptionApi getStorageEncryptionProgress GET /api/2.0/settings/encryption/progress Get the storage encryption progress
Api.SettingsEncryptionApi getStorageEncryptionSettings GET /api/2.0/settings/encryption/settings Get the storage encryption settings
Api.SettingsEncryptionApi startStorageEncryption POST /api/2.0/settings/encryption/start Start the storage encryption process
Api.SettingsGreetingSettingsApi getGreetingSettings GET /api/2.0/settings/greetingsettings Get greeting settings
Api.SettingsGreetingSettingsApi getIsDefaultGreetingSettings GET /api/2.0/settings/greetingsettings/isdefault Check the default greeting settings
Api.SettingsGreetingSettingsApi restoreGreetingSettings POST /api/2.0/settings/greetingsettings/restore Restore the greeting settings
Api.SettingsGreetingSettingsApi saveGreetingSettings POST /api/2.0/settings/greetingsettings Save the greeting settings
Api.SettingsIPRestrictionsApi getIpRestrictions GET /api/2.0/settings/iprestrictions Get the IP portal restrictions
Api.SettingsIPRestrictionsApi readIpRestrictionsSettings GET /api/2.0/settings/iprestrictions/settings Get the IP restriction settings
Api.SettingsIPRestrictionsApi saveIpRestrictions PUT /api/2.0/settings/iprestrictions Update the IP restrictions
Api.SettingsIPRestrictionsApi updateIpRestrictionsSettings PUT /api/2.0/settings/iprestrictions/settings Update the IP restriction settings
Api.SettingsLicenseApi acceptLicense POST /api/2.0/settings/license/accept Activate a license
Api.SettingsLicenseApi getIsLicenseRequired GET /api/2.0/settings/license/required Request a license
Api.SettingsLicenseApi refreshLicense GET /api/2.0/settings/license/refresh Refresh the license
Api.SettingsLicenseApi uploadLicense POST /api/2.0/settings/license Upload a license
Api.SettingsLoginSettingsApi getLoginSettings GET /api/2.0/settings/security/loginsettings Get the login settings
Api.SettingsLoginSettingsApi setDefaultLoginSettings DELETE /api/2.0/settings/security/loginsettings Reset the login settings
Api.SettingsLoginSettingsApi updateLoginSettings PUT /api/2.0/settings/security/loginsettings Update the login settings
Api.SettingsMessagesApi enableAdminMessageSettings POST /api/2.0/settings/messagesettings Enable the administrator message settings
Api.SettingsMessagesApi sendAdminMail POST /api/2.0/settings/sendadmmail Send a message to the administrator
Api.SettingsMessagesApi sendJoinInviteMail POST /api/2.0/settings/sendjoininvite Sends an invitation email
Api.SettingsNotificationsApi getNotificationSettings GET /api/2.0/settings/notification/{type} Check notification availability
Api.SettingsNotificationsApi getRoomsNotificationSettings GET /api/2.0/settings/notification/rooms Get room notification settings
Api.SettingsNotificationsApi setNotificationSettings POST /api/2.0/settings/notification Enable notifications
Api.SettingsNotificationsApi setRoomsNotificationStatus POST /api/2.0/settings/notification/rooms Set room notification status
Api.SettingsOwnerApi sendOwnerChangeInstructions POST /api/2.0/settings/owner Send the owner change instructions
Api.SettingsOwnerApi updatePortalOwner PUT /api/2.0/settings/owner Update the portal owner
Api.SettingsQuotaApi getUserQuotaSettings GET /api/2.0/settings/userquotasettings Get the user quota settings
Api.SettingsQuotaApi saveRoomQuotaSettings POST /api/2.0/settings/roomquotasettings Save the room quota settings
Api.SettingsQuotaApi setTenantQuotaSettings PUT /api/2.0/settings/tenantquotasettings Save the tenant quota settings
Api.SettingsRebrandingApi deleteAdditionalWhiteLabelSettings DELETE /api/2.0/settings/rebranding/additional Delete the additional white label settings
Api.SettingsRebrandingApi deleteCompanyWhiteLabelSettings DELETE /api/2.0/settings/rebranding/company Delete the company white label settings
Api.SettingsRebrandingApi getAdditionalWhiteLabelSettings GET /api/2.0/settings/rebranding/additional Get the additional white label settings
Api.SettingsRebrandingApi getCompanyWhiteLabelSettings GET /api/2.0/settings/rebranding/company Get the company white label settings
Api.SettingsRebrandingApi getEnableWhitelabel GET /api/2.0/settings/enablewhitelabel Check the white label availability
Api.SettingsRebrandingApi getIsDefaultWhiteLabelLogoText GET /api/2.0/settings/whitelabel/logotext/isdefault Check the default white label logo text
Api.SettingsRebrandingApi getIsDefaultWhiteLabelLogos GET /api/2.0/settings/whitelabel/logos/isdefault Check the default white label logos
Api.SettingsRebrandingApi getLicensorData GET /api/2.0/settings/companywhitelabel Get the licensor data
Api.SettingsRebrandingApi getWhiteLabelLogoText GET /api/2.0/settings/whitelabel/logotext Get the white label logo text
Api.SettingsRebrandingApi getWhiteLabelLogos GET /api/2.0/settings/whitelabel/logos Get the white label logos
Api.SettingsRebrandingApi restoreWhiteLabelLogoText PUT /api/2.0/settings/whitelabel/logotext/restore Restore the white label logo text
Api.SettingsRebrandingApi restoreWhiteLabelLogos PUT /api/2.0/settings/whitelabel/logos/restore Restore the white label logos
Api.SettingsRebrandingApi saveAdditionalWhiteLabelSettings POST /api/2.0/settings/rebranding/additional Save the additional white label settings
Api.SettingsRebrandingApi saveCompanyWhiteLabelSettings POST /api/2.0/settings/rebranding/company Save the company white label settings
Api.SettingsRebrandingApi saveWhiteLabelLogoText POST /api/2.0/settings/whitelabel/logotext/save Save the white label logo text settings
Api.SettingsRebrandingApi saveWhiteLabelSettings POST /api/2.0/settings/whitelabel/logos/save Save the white label logos
Api.SettingsRebrandingApi saveWhiteLabelSettingsFromFiles POST /api/2.0/settings/whitelabel/logos/savefromfiles Save the white label logos from files
Api.SettingsSSOApi getDefaultSsoSettingsV2 GET /api/2.0/settings/ssov2/default Get the default SSO settings
Api.SettingsSSOApi getSsoSettingsV2 GET /api/2.0/settings/ssov2 Get the SSO settings
Api.SettingsSSOApi getSsoSettingsV2Constants GET /api/2.0/settings/ssov2/constants Get the SSO settings constants
Api.SettingsSSOApi resetSsoSettingsV2 DELETE /api/2.0/settings/ssov2 Reset the SSO settings
Api.SettingsSSOApi saveSsoSettingsV2 POST /api/2.0/settings/ssov2 Save the SSO settings
Api.SettingsSecurityApi getEnabledModules GET /api/2.0/settings/security/modules Get the enabled modules
Api.SettingsSecurityApi getIsProductAdministrator GET /api/2.0/settings/security/administrator Check a product administrator
Api.SettingsSecurityApi getPasswordSettings GET /api/2.0/settings/security/password Get the password settings
Api.SettingsSecurityApi getProductAdministrators GET /api/2.0/settings/security/administrator/{productid} Get the product administrators
Api.SettingsSecurityApi getWebItemSecurityInfo GET /api/2.0/settings/security/{id} Get the module availability
Api.SettingsSecurityApi getWebItemSettingsSecurityInfo GET /api/2.0/settings/security Get the security settings
Api.SettingsSecurityApi setAccessToWebItems PUT /api/2.0/settings/security/access Set the security settings to modules
Api.SettingsSecurityApi setProductAdministrator PUT /api/2.0/settings/security/administrator Set a product administrator
Api.SettingsSecurityApi setWebItemSecurity PUT /api/2.0/settings/security Set the module security settings
Api.SettingsSecurityApi updatePasswordSettings PUT /api/2.0/settings/security/password Set the password settings
Api.SettingsStatisticsApi getSpaceUsageStatistics GET /api/2.0/settings/statistics/spaceusage/{id} Get the space usage statistics
Api.SettingsStorageApi getAllBackupStorages GET /api/2.0/settings/storage/backup Get the backup storages
Api.SettingsStorageApi getAllCdnStorages GET /api/2.0/settings/storage/cdn Get the CDN storages
Api.SettingsStorageApi getAllStorages GET /api/2.0/settings/storage Get storages
Api.SettingsStorageApi getAmazonS3Regions GET /api/2.0/settings/storage/s3/regions Get Amazon regions
Api.SettingsStorageApi getStorageProgress GET /api/2.0/settings/storage/progress Get the storage progress
Api.SettingsStorageApi resetCdnToDefault DELETE /api/2.0/settings/storage/cdn Reset the CDN storage settings
Api.SettingsStorageApi resetStorageToDefault DELETE /api/2.0/settings/storage Reset the storage settings
Api.SettingsStorageApi updateCdnStorage PUT /api/2.0/settings/storage/cdn Update the CDN storage
Api.SettingsStorageApi updateStorage PUT /api/2.0/settings/storage Update a storage
Api.SettingsTFASettingsApi getTfaAppCodes GET /api/2.0/settings/tfaappcodes Get the TFA codes
Api.SettingsTFASettingsApi getTfaConfirmUrl GET /api/2.0/settings/tfaapp/confirm Get confirmation email
Api.SettingsTFASettingsApi getTfaSettings GET /api/2.0/settings/tfaapp Get the TFA settings
Api.SettingsTFASettingsApi tfaAppGenerateSetupCode GET /api/2.0/settings/tfaapp/setup Generate setup code
Api.SettingsTFASettingsApi tfaValidateAuthCode POST /api/2.0/settings/tfaapp/validate Validate the TFA code
Api.SettingsTFASettingsApi unlinkTfaApp PUT /api/2.0/settings/tfaappnewapp Unlink the TFA application
Api.SettingsTFASettingsApi updateTfaAppCodes PUT /api/2.0/settings/tfaappnewcodes Update the TFA codes
Api.SettingsTFASettingsApi updateTfaSettings PUT /api/2.0/settings/tfaapp Update the TFA settings
Api.SettingsTFASettingsApi updateTfaSettingsLink PUT /api/2.0/settings/tfaappwithlink Get a confirmation email for updating TFA settings
Api.SettingsWebhooksApi createWebhook POST /api/2.0/settings/webhook Create a webhook
Api.SettingsWebhooksApi enableWebhook PUT /api/2.0/settings/webhook/enable Enable a webhook
Api.SettingsWebhooksApi getTenantWebhooks GET /api/2.0/settings/webhook Get webhooks
Api.SettingsWebhooksApi getWebhookTriggers GET /api/2.0/settings/webhook/triggers Get webhook triggers
Api.SettingsWebhooksApi getWebhooksLogs GET /api/2.0/settings/webhooks/log Get webhook logs
Api.SettingsWebhooksApi removeWebhook DELETE /api/2.0/settings/webhook/{id} Remove a webhook
Api.SettingsWebhooksApi retryWebhook PUT /api/2.0/settings/webhook/{id}/retry Retry a webhook
Api.SettingsWebhooksApi retryWebhooks PUT /api/2.0/settings/webhook/retry Retry webhooks
Api.SettingsWebhooksApi updateWebhook PUT /api/2.0/settings/webhook Update a webhook
Api.SettingsWebpluginsApi addWebPluginFromFile POST /api/2.0/settings/webplugins Add a web plugin
Api.SettingsWebpluginsApi deleteWebPlugin DELETE /api/2.0/settings/webplugins/{name} Delete a web plugin
Api.SettingsWebpluginsApi getWebPlugin GET /api/2.0/settings/webplugins/{name} Get a web plugin by name
Api.SettingsWebpluginsApi getWebPlugins GET /api/2.0/settings/webplugins Get web plugins
Api.SettingsWebpluginsApi updateWebPlugin PUT /api/2.0/settings/webplugins/{name} Update a web plugin
Api.ThirdPartyApi getThirdPartyCode GET /api/2.0/thirdparty/{provider} Get the code request

Documentation for Models

Models list

About

A simple JavaScript SDK for integrating with the ONLYOFFICE DocSpace API

Topics

sdk integration onlyoffice

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Contributors

Languages