A simple Python SDK for integrating with the ONLYOFFICE DocSpace API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for AscensioSystemSIA from gravatar.com AscensioSystemSIA

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache-2.0)
  • Author: Ascensio System SIA
  • Tags onlyoffice , docspace , sdk
  • Requires: Python <4.0, >=3.9
Classifiers
Report project as malware

Project description

docspace_api_sdk

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

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

Requirements

Python 3.9+

Installation & Usage

Using pip

If the Python package is hosted in a repository, you can install it directly using:

pip install git+https://github.com/ONLYOFFICE/docspace-api-sdk-python.git

If required, run with root permissions:

sudo pip install git+https://github.com/ONLYOFFICE/docspace-api-sdk-python.git

Then import the package:

import docspace_api_sdk

Using setuptools

Alternatively, you can install the package using setuptools:

python setup.py install --user

To install the package for all users, run the following command:

sudo python setup.py install

Then import the package:

import docspace_api_sdk

Getting Started

Please follow the installation procedure and then run the following:

import docspace_api_sdk
from docspace_api_sdk.rest import ApiException
from pprint import pprint

configuration = docspace_api_sdk.Configuration(
    host = "https://your-docspace.onlyoffice.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = docspace_api_sdk.ApiKeysApi(api_client)
    create_api_key_request_dto = docspace_api_sdk.CreateApiKeyRequestDto() # CreateApiKeyRequestDto |  (optional)

    try:
        # Create a user API key
        api_response = api_instance.create_api_key(create_api_key_request_dto=create_api_key_request_dto)
        print("The response of ApiKeysApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiKeysApi->create_api_key: %s\n" % e)

Documentation For Authorization

Authentication schemes defined for the API:

asc_auth_key

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

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:

Documentation for API Endpoints

All URIs are relative to https://your-docspace.onlyoffice.com

ApiKeys
Method HTTP request Description
ApiKeysApi
create_api_key POST /api/2.0/keys Create a user API key
delete_api_key DELETE /api/2.0/keys/{keyId} Delete a user API key
get_all_permissions GET /api/2.0/keys/permissions Get API key permissions
get_api_key GET /api/2.0/keys/@self Get current user's API key
get_api_keys GET /api/2.0/keys Get current user's API keys
update_api_key PUT /api/2.0/keys/{keyId} Update an API key
Authentication
Method HTTP request Description
AuthenticationApi
authenticate_me POST /api/2.0/authentication Authenticate a user
authenticate_me_from_body_with_code POST /api/2.0/authentication/{code} Authenticate a user by code
check_confirm POST /api/2.0/authentication/confirm Open confirmation email URL
get_is_authentificated GET /api/2.0/authentication Check authentication
logout POST /api/2.0/authentication/logout Log out
save_mobile_phone POST /api/2.0/authentication/setphone Set a mobile phone
send_sms_code POST /api/2.0/authentication/sendsms Send SMS code
Backup
Method HTTP request Description
BackupApi
create_backup_schedule POST /api/2.0/backup/createbackupschedule Create the backup schedule
delete_backup DELETE /api/2.0/backup/deletebackup/{id} Delete the backup
delete_backup_history DELETE /api/2.0/backup/deletebackuphistory Delete the backup history
delete_backup_schedule DELETE /api/2.0/backup/deletebackupschedule Delete the backup schedule
get_backup_history GET /api/2.0/backup/getbackuphistory Get the backup history
get_backup_progress GET /api/2.0/backup/getbackupprogress Get the backup progress
get_backup_schedule GET /api/2.0/backup/getbackupschedule Get the backup schedule
get_backups_count GET /api/2.0/backup/getbackupscount Get the number of backups
get_backups_service_state GET /api/2.0/backup/getservicestate Get the backup service state
get_restore_progress GET /api/2.0/backup/getrestoreprogress Get the restoring progress
start_backup POST /api/2.0/backup/startbackup Start the backup
start_backup_restore POST /api/2.0/backup/startrestore Start the restoring process
Capabilities
Method HTTP request Description
CapabilitiesApi
get_portal_capabilities GET /api/2.0/capabilities Get portal capabilities
Files
Method HTTP request Description
FilesApi
add_file_to_recent POST /api/2.0/files/file/{fileId}/recent Add a file to the Recent section
add_templates POST /api/2.0/files/templates Add template files
change_version_history PUT /api/2.0/files/file/{fileId}/history Change version history
check_fill_form_draft POST /api/2.0/files/masterform/{fileId}/checkfillformdraft Check the form draft filling
copy_file_as POST /api/2.0/files/file/{fileId}/copyas Copy a file
create_edit_session POST /api/2.0/files/file/{fileId}/edit_session Create the editing session
create_file POST /api/2.0/files/{folderId}/file Create a file
create_file_in_my_documents POST /api/2.0/files/@my/file Create a file in the My documents section
create_file_primary_external_link POST /api/2.0/files/file/{id}/link Create primary external link
create_html_file POST /api/2.0/files/{folderId}/html Create an HTML file
create_html_file_in_my_documents POST /api/2.0/files/@my/html Create an HTML file in the My documents section
create_text_file POST /api/2.0/files/{folderId}/text Create a text file
create_text_file_in_my_documents POST /api/2.0/files/@my/text Create a text file in the My documents section
create_thumbnails POST /api/2.0/files/thumbnails Create file thumbnails
delete_file DELETE /api/2.0/files/file/{fileId} Delete a file
delete_recent DELETE /api/2.0/files/recent Delete recent files
delete_templates DELETE /api/2.0/files/templates Delete template files
get_all_form_roles GET /api/2.0/files/file/{fileId}/formroles Get form roles
get_edit_diff_url GET /api/2.0/files/file/{fileId}/edit/diff Get changes URL
get_edit_history GET /api/2.0/files/file/{fileId}/edit/history Get version history
get_file_history GET /api/2.0/files/file/{fileId}/log Get file history
get_file_info GET /api/2.0/files/file/{fileId} Get file information
get_file_links GET /api/2.0/files/file/{id}/links Get file external links
get_file_primary_external_link GET /api/2.0/files/file/{id}/link Get primary external link
get_file_version_info GET /api/2.0/files/file/{fileId}/history Get file versions
get_fill_result GET /api/2.0/files/file/fillresult Get form-filling result
get_presigned_file_uri GET /api/2.0/files/file/{fileId}/presigned Get file download link asynchronously
get_presigned_uri GET /api/2.0/files/file/{fileId}/presigneduri Get file download link
get_protected_file_users GET /api/2.0/files/file/{fileId}/protectusers Get users access rights to the protected file
get_reference_data POST /api/2.0/files/file/referencedata Get reference data
is_form_pdf GET /api/2.0/files/file/{fileId}/isformpdf Check the PDF file
lock_file PUT /api/2.0/files/file/{fileId}/lock Lock a file
manage_form_filling PUT /api/2.0/files/file/{fileId}/manageformfilling Perform form filling action
open_edit_file GET /api/2.0/files/file/{fileId}/openedit Open a file configuration
restore_file_version POST /api/2.0/files/file/{fileId}/restoreversion Restore a file version
save_editing_file_from_form PUT /api/2.0/files/file/{fileId}/saveediting Save file edits
save_file_as_pdf POST /api/2.0/files/file/{id}/saveaspdf Save a file as PDF
save_form_role_mapping POST /api/2.0/files/file/{fileId}/formrolemapping Save form role mapping
set_custom_filter_tag PUT /api/2.0/files/file/{fileId}/customfilter Set the Custom Filter editing mode
set_file_external_link PUT /api/2.0/files/file/{id}/links Set an external link
set_file_order PUT /api/2.0/files/{fileId}/order Set file order
set_files_order PUT /api/2.0/files/order Set order of files
start_edit_file POST /api/2.0/files/file/{fileId}/startedit Start file editing
start_filling_file PUT /api/2.0/files/file/{fileId}/startfilling Start file filling
toggle_file_favorite GET /api/2.0/files/favorites/{fileId} Change the file favorite status
track_edit_file GET /api/2.0/files/file/{fileId}/trackeditfile Track file editing
update_file PUT /api/2.0/files/file/{fileId} Update a file
FoldersApi
check_upload POST /api/2.0/files/{folderId}/upload/check Check file uploads
create_folder POST /api/2.0/files/folder/{folderId} Create a folder
create_folder_primary_external_link POST /api/2.0/files/folder/{id}/link Create primary external link
create_report_folder_history POST /api/2.0/files/folder/{folderId}/log/report Generates folder history
delete_folder DELETE /api/2.0/files/folder/{folderId} Delete a folder
get_favorites_folder GET /api/2.0/files/@favorites Get the Favorites section
get_files_used_space GET /api/2.0/files/filesusedspace Get used space of files
get_folder GET /api/2.0/files/{folderId}/formfilter Get folder form filter
get_folder_by_folder_id GET /api/2.0/files/{folderId} Get a folder by ID
get_folder_history GET /api/2.0/files/folder/{folderId}/log Get folder history
get_folder_info GET /api/2.0/files/folder/{folderId} Get folder information
get_folder_links GET /api/2.0/files/folder/{id}/links Get the folder links
get_folder_path GET /api/2.0/files/folder/{folderId}/path Get the folder path
get_folder_primary_external_link GET /api/2.0/files/folder/{id}/link Get primary external link
get_folders GET /api/2.0/files/{folderId}/subfolders Get subfolders
get_my_folder GET /api/2.0/files/@my Get the My documents section
get_new_folder_items GET /api/2.0/files/{folderId}/news Get new folder items
get_privacy_folder GET /api/2.0/files/@privacy Get the Private Room section
get_recent_folder GET /api/2.0/files/recent Get the Recent section
get_root_folders GET /api/2.0/files/@root Get filtered sections
get_trash_folder GET /api/2.0/files/@trash Get the Trash section
insert_file POST /api/2.0/files/{folderId}/insert Insert a file
insert_file_to_my_from_body POST /api/2.0/files/@my/insert Insert a file to the My documents section
rename_folder PUT /api/2.0/files/folder/{folderId} Rename a folder
set_folder_order PUT /api/2.0/files/folder/{folderId}/order Set folder order
set_folder_primary_external_link PUT /api/2.0/files/folder/{id}/links Set the folder external link
upload_file POST /api/2.0/files/{folderId}/upload Upload a file
upload_file_to_my POST /api/2.0/files/@my/upload Upload a file to the My documents section
OperationsApi
add_favorites POST /api/2.0/files/favorites Add favorite files and folders
bulk_download PUT /api/2.0/files/fileops/bulkdownload Bulk download
check_conversion_status GET /api/2.0/files/file/{fileId}/checkconversion Get conversion status
check_move_or_copy_batch_items GET /api/2.0/files/fileops/move Move or copy files to a folder
check_move_or_copy_dest_folder GET /api/2.0/files/fileops/checkdestfolder Check for moving or copying files to a folder
copy_batch_items PUT /api/2.0/files/fileops/copy Copy to the folder
create_upload_session POST /api/2.0/files/{folderId}/upload/create_session Chunked upload
delete_batch_items PUT /api/2.0/files/fileops/delete Delete files and folders
delete_favorites_from_body DELETE /api/2.0/files/favorites Delete favorite files and folders (using body parameters)
delete_file_versions PUT /api/2.0/files/fileops/deleteversion Delete file versions
duplicate_batch_items PUT /api/2.0/files/fileops/duplicate Duplicate files and folders
empty_trash PUT /api/2.0/files/fileops/emptytrash Empty the Trash folder
get_operation_statuses GET /api/2.0/files/fileops Get active file operations
get_operation_statuses_by_type GET /api/2.0/files/fileops/{operationType} Get file operation statuses
mark_as_read PUT /api/2.0/files/fileops/markasread Mark as read
move_batch_items PUT /api/2.0/files/fileops/move Move or copy to a folder
start_file_conversion PUT /api/2.0/files/file/{fileId}/checkconversion Start file conversion
terminate_tasks PUT /api/2.0/files/fileops/terminate/{id} Finish active operations
update_file_comment PUT /api/2.0/files/file/{fileId}/comment Update a comment
QuotaApi
reset_room_quota PUT /api/2.0/files/rooms/resetquota Reset the room quota limit
update_rooms_quota PUT /api/2.0/files/rooms/roomquota Change the room quota limit
SettingsApi
change_access_to_thirdparty PUT /api/2.0/files/thirdparty Change the third-party settings access
change_automatically_clean_up PUT /api/2.0/files/settings/autocleanup Update the trash bin auto-clearing setting
change_default_access_rights PUT /api/2.0/files/settings/dafaultaccessrights Change the default access rights
change_delete_confirm PUT /api/2.0/files/changedeleteconfrim Confirm the file deletion
change_download_zip_from_body PUT /api/2.0/files/settings/downloadtargz Change the archive format (using body parameters)
check_doc_service_url PUT /api/2.0/files/docservice Check the document service URL
display_file_extension PUT /api/2.0/files/displayfileextension Display a file extension
display_recent PUT /api/2.0/files/displayrecent Display the Recent folder
external_share PUT /api/2.0/files/settings/external Change the external sharing ability
external_share_social_media PUT /api/2.0/files/settings/externalsocialmedia Change the external sharing ability on social networks
forcesave PUT /api/2.0/files/forcesave Change the forcesaving ability
get_automatically_clean_up GET /api/2.0/files/settings/autocleanup Get the trash bin auto-clearing setting
get_doc_service_url GET /api/2.0/files/docservice Get the document service URL
get_files_module GET /api/2.0/files/info Get the Documents information
get_files_settings GET /api/2.0/files/settings Get file settings
hide_confirm_cancel_operation PUT /api/2.0/files/hideconfirmcanceloperation Hide confirmation dialog when canceling operations
hide_confirm_convert PUT /api/2.0/files/hideconfirmconvert Hide the confirmation dialog when converting
hide_confirm_room_lifetime PUT /api/2.0/files/hideconfirmroomlifetime Hide confirmation dialog when changing room lifetime settings
is_available_privacy_room_settings GET /api/2.0/files/@privacy/available Check the Private Room availability
keep_new_file_name PUT /api/2.0/files/keepnewfilename Ask a new file name
set_open_editor_in_same_tab PUT /api/2.0/files/settings/openeditorinsametab Open document in the same browser tab
store_forcesave PUT /api/2.0/files/storeforcesave Change the ability to store the forcesaved files
store_original PUT /api/2.0/files/storeoriginal Change the ability to upload original formats
update_file_if_exist PUT /api/2.0/files/updateifexist Update a file version if it exists
SharingApi
apply_external_share_password POST /api/2.0/files/share/{key}/password Apply external data password
change_file_owner POST /api/2.0/files/owner Change the file owner
get_external_share_data GET /api/2.0/files/share/{key} Get the external data
get_file_security_info GET /api/2.0/files/file/{id}/share Get the shared file information
get_folder_security_info GET /api/2.0/files/folder/{id}/share Get the shared folder information
get_groups_members_with_file_security GET /api/2.0/files/file/{fileId}/group/{groupId}/share Get file group members with security information
get_groups_members_with_folder_security GET /api/2.0/files/folder/{folderId}/group/{groupId}/share Get folder group members with security information
get_security_info POST /api/2.0/files/share Get the sharing rights
get_shared_users GET /api/2.0/files/file/{fileId}/sharedusers Get user access rights by file ID
remove_security_info DELETE /api/2.0/files/share Remove the sharing rights
send_editor_notify POST /api/2.0/files/file/{fileId}/sendeditornotify Send the mention message
set_file_security_info PUT /api/2.0/files/file/{fileId}/share Share a file
set_folder_security_info PUT /api/2.0/files/folder/{folderId}/share Share a folder
set_security_info PUT /api/2.0/files/share Set the sharing rights
ThirdPartyIntegrationApi
delete_third_party DELETE /api/2.0/files/thirdparty/{providerId} Remove a third-party account
get_all_providers GET /api/2.0/files/thirdparty/providers Get all providers
get_backup_third_party_account GET /api/2.0/files/thirdparty/backup Get a third-party account backup
get_capabilities GET /api/2.0/files/thirdparty/capabilities Get providers
get_common_third_party_folders GET /api/2.0/files/thirdparty/common Get the common third-party services
get_third_party_accounts GET /api/2.0/files/thirdparty Get the third-party accounts
save_third_party POST /api/2.0/files/thirdparty Save a third-party account
save_third_party_backup POST /api/2.0/files/thirdparty/backup Save a third-party account backup
Group
Method HTTP request Description
GroupApi
add_group POST /api/2.0/group Add a new group
add_members_to PUT /api/2.0/group/{id}/members Add group members
delete_group DELETE /api/2.0/group/{id} Delete a group
get_group GET /api/2.0/group/{id} Get a group
get_group_by_user_id GET /api/2.0/group/user/{userid} Get user groups
get_groups GET /api/2.0/group Get groups
move_members_to PUT /api/2.0/group/{fromId}/members/{toId} Move group members
remove_members_from DELETE /api/2.0/group/{id}/members Remove group members
set_group_manager PUT /api/2.0/group/{id}/manager Set a group manager
set_members_to POST /api/2.0/group/{id}/members Replace group members
update_group PUT /api/2.0/group/{id} Update a group
SearchApi
get_groups_with_files_shared GET /api/2.0/group/file/{id} Get groups with file sharing settings
get_groups_with_folders_shared GET /api/2.0/group/folder/{id} Get groups with folder sharing settings
get_groups_with_rooms_shared GET /api/2.0/group/room/{id} Get groups with room sharing settings
Migration
Method HTTP request Description
MigrationApi
cancel_migration POST /api/2.0/migration/cancel Cancel migration
clear_migration POST /api/2.0/migration/clear Clear migration
finish_migration POST /api/2.0/migration/finish Finish migration
get_migration_logs GET /api/2.0/migration/logs Get migration logs
get_migration_status GET /api/2.0/migration/status Get migration status
list_migrations GET /api/2.0/migration/list Get migrations
start_migration POST /api/2.0/migration/migrate Start migration
upload_and_initialize_migration POST /api/2.0/migration/init/{migratorName} Upload and initialize migration
OAuth20
Method HTTP request Description
AuthorizationApi
authorize_o_auth GET /oauth2/authorize OAuth2 authorization endpoint
exchange_token POST /oauth2/token OAuth2 token endpoint
submit_consent POST /oauth2/authorize OAuth2 consent endpoint
ClientManagementApi
change_activation PATCH /api/2.0/clients/{clientId}/activation Change the client activation status
create_client POST /api/2.0/clients Create a new OAuth2 client
delete_client DELETE /api/2.0/clients/{clientId} Delete an OAuth2 client
regenerate_secret PATCH /api/2.0/clients/{clientId}/regenerate Regenerate the client secret
revoke_user_client DELETE /api/2.0/clients/{clientId}/revoke Revoke client consent
update_client PUT /api/2.0/clients/{clientId} Update an existing OAuth2 client
ClientQueryingApi
get_client GET /api/2.0/clients/{clientId} Get client details
get_client_info GET /api/2.0/clients/{clientId}/info Get detailed client information
get_clients GET /api/2.0/clients Get clients
get_clients_info GET /api/2.0/clients/info Get detailed information of clients
get_consents GET /api/2.0/clients/consents Get user consents
get_public_client_info GET /api/2.0/clients/{clientId}/public/info Get public client information
ScopeManagementApi
get_scopes GET /api/2.0/scopes Get available OAuth2 scopes
People
Method HTTP request Description
GuestsApi
approve_guest_share_link POST /api/2.0/people/guests/share/approve Approve a guest sharing link
delete_guests DELETE /api/2.0/people/guests Delete guests
PasswordApi
change_user_password PUT /api/2.0/people/{userid}/password Change a user password
send_user_password POST /api/2.0/people/password Remind a user password
PhotosApi
create_member_photo_thumbnails POST /api/2.0/people/{userid}/photo/thumbnails Create photo thumbnails
delete_member_photo DELETE /api/2.0/people/{userid}/photo Delete a user photo
get_member_photo GET /api/2.0/people/{userid}/photo Get a user photo
update_member_photo PUT /api/2.0/people/{userid}/photo Update a user photo
upload_member_photo POST /api/2.0/people/{userid}/photo Upload a user photo
ProfilesApi
add_member POST /api/2.0/people Add a user
delete_member DELETE /api/2.0/people/{userid} Delete a user
delete_profile DELETE /api/2.0/people/@self Delete my profile
get_all_profiles GET /api/2.0/people Get profiles
get_claims GET /api/2.0/people/tokendiagnostics Get user claims
get_profile_by_email GET /api/2.0/people/email Get a profile by user email
get_profile_by_user_id GET /api/2.0/people/{userid} Get a profile by user ID
get_self_profile GET /api/2.0/people/@self Get my profile
invite_users POST /api/2.0/people/invite Invite users
remove_users PUT /api/2.0/people/delete Delete users
resend_user_invites PUT /api/2.0/people/invite Resend activation emails
send_email_change_instructions POST /api/2.0/people/email Send instructions to change email
update_member PUT /api/2.0/people/{userid} Update a user
update_member_culture PUT /api/2.0/people/{userid}/culture Update a user culture code
QuotaApi
reset_users_quota PUT /api/2.0/people/resetquota Reset a user quota limit
update_user_quota PUT /api/2.0/people/userquota Change a user quota limit
SearchApi
get_accounts_entries_with_files_shared GET /api/2.0/accounts/file/{id}/search Get account entries with file sharing settings
get_accounts_entries_with_folders_shared GET /api/2.0/accounts/folder/{id}/search Get account entries with folder sharing settings
get_accounts_entries_with_rooms_shared GET /api/2.0/accounts/room/{id}/search Get account entries
get_search GET /api/2.0/people/@search/{query} Search users
get_simple_by_filter GET /api/2.0/people/simple/filter Search users by extended filter
get_users_with_files_shared GET /api/2.0/people/file/{id} Get users with file sharing settings
get_users_with_folders_shared GET /api/2.0/people/folder/{id} Get users with folder sharing settings
get_users_with_room_shared GET /api/2.0/people/room/{id} Get users with room sharing settings
search_users_by_extended_filter GET /api/2.0/people/filter Search users with detailed information by extended filter
search_users_by_query GET /api/2.0/people/search Search users (using query parameters)
search_users_by_status GET /api/2.0/people/status/{status}/search Search users by status filter
ThemeApi
change_portal_theme PUT /api/2.0/people/theme Change the portal theme
get_portal_theme GET /api/2.0/people/theme Get the portal theme
ThirdPartyAccountsApi
get_third_party_auth_providers GET /api/2.0/people/thirdparty/providers Get third-party accounts
link_third_party_account PUT /api/2.0/people/thirdparty/linkaccount Link a third-pary account
signup_third_party_account POST /api/2.0/people/thirdparty/signup Create a third-pary account
unlink_third_party_account DELETE /api/2.0/people/thirdparty/unlinkaccount Unlink a third-pary account
UserDataApi
get_delete_personal_folder_progress GET /api/2.0/people/delete/personal/progress Get the progress of deleting the personal folder
get_reassign_progress GET /api/2.0/people/reassign/progress/{userid} Get the reassignment progress
get_remove_progress GET /api/2.0/people/remove/progress/{userid} Get the deletion progress
necessary_reassign GET /api/2.0/people/reassign/necessary Check data for reassignment need
send_instructions_to_delete PUT /api/2.0/people/self/delete Send the deletion instructions
start_delete_personal_folder POST /api/2.0/people/delete/personal/start Delete the personal folder
start_reassign POST /api/2.0/people/reassign/start Start the data reassignment
start_remove POST /api/2.0/people/remove/start Start the data deletion
terminate_reassign PUT /api/2.0/people/reassign/terminate Terminate the data reassignment
terminate_remove PUT /api/2.0/people/remove/terminate Terminate the data deletion
UserStatusApi
get_by_status GET /api/2.0/people/status/{status} Get profiles by status
update_user_activation_status PUT /api/2.0/people/activationstatus/{activationstatus} Set an activation status to the users
update_user_status PUT /api/2.0/people/status/{status} Change a user status
UserTypeApi
get_user_type_update_progress GET /api/2.0/people/type/progress/{userid} Get the progress of updating user type
star_user_typet_update POST /api/2.0/people/type Start updating user type
terminate_user_type_update PUT /api/2.0/people/type/terminate Terminate updating user type
update_user_type PUT /api/2.0/people/type/{type} Change a user type
Portal
Method HTTP request Description
GuestsApi
get_guest_sharing_link GET /api/2.0/people/guests/{userid}/share Get a guest sharing link
PaymentApi
calculate_wallet_payment PUT /api/2.0/portal/payment/calculatewallet Calculate the wallet payment amount
change_tenant_wallet_service_state POST /api/2.0/portal/payment/servicestate Change wallet service state
create_customer_operations_report POST /api/2.0/portal/payment/customer/operationsreport Start the customer operations report generation
get_checkout_setup_url GET /api/2.0/portal/payment/chechoutsetupurl Get the checkout setup page URL
get_customer_balance GET /api/2.0/portal/payment/customer/balance Get the customer balance
get_customer_info GET /api/2.0/portal/payment/customerinfo Get the customer information
get_customer_operations GET /api/2.0/portal/payment/customer/operations Get the customer operations
get_customer_operations_report GET /api/2.0/portal/payment/customer/operationsreport Get the status of the customer operations report generation
get_payment_account GET /api/2.0/portal/payment/account Get the payment account
get_payment_currencies GET /api/2.0/portal/payment/currencies Get currencies
get_payment_quotas GET /api/2.0/portal/payment/quotas Get quotas
get_payment_url PUT /api/2.0/portal/payment/url Get the payment page URL
get_portal_prices GET /api/2.0/portal/payment/prices Get prices
get_quota_payment_information GET /api/2.0/portal/payment/quota Get quota payment information
get_tenant_wallet_service_settings GET /api/2.0/portal/payment/servicessettings Get wallet services settings
get_tenant_wallet_settings GET /api/2.0/portal/payment/topupsettings Get wallet auto top-up settings
get_wallet_service GET /api/2.0/portal/payment/walletservice Get wallet service
get_wallet_services GET /api/2.0/portal/payment/walletservices Get wallet services
send_payment_request POST /api/2.0/portal/payment/request Send a payment request
set_tenant_wallet_settings POST /api/2.0/portal/payment/topupsettings Set wallet auto top-up settings
terminate_customer_operations_report DELETE /api/2.0/portal/payment/customer/operationsreport Terminate the customer operations report generation
top_up_deposit POST /api/2.0/portal/payment/deposit Put money on deposit
update_payment PUT /api/2.0/portal/payment/update Update the payment quantity
update_wallet_payment PUT /api/2.0/portal/payment/updatewallet Update the wallet payment quantity
QuotaApi
get_portal_quota GET /api/2.0/portal/quota Get a portal quota
get_portal_tariff GET /api/2.0/portal/tariff Get a portal tariff
get_portal_used_space GET /api/2.0/portal/usedspace Get the portal used space
get_right_quota GET /api/2.0/portal/quota/right Get the recommended quota
SettingsApi
continue_portal PUT /api/2.0/portal/continue Restore a portal
delete_portal DELETE /api/2.0/portal/delete Delete a portal
get_portal_information GET /api/2.0/portal Get a portal
get_portal_path GET /api/2.0/portal/path Get a path to the portal
send_delete_instructions POST /api/2.0/portal/delete Send removal instructions
send_suspend_instructions POST /api/2.0/portal/suspend Send suspension instructions
suspend_portal PUT /api/2.0/portal/suspend Deactivate a portal
UsersApi
get_invitation_link GET /api/2.0/portal/users/invite/{employeeType} Get an invitation link
get_portal_users_count GET /api/2.0/portal/userscount Get a number of portal users
get_user_by_id GET /api/2.0/portal/users/{userID} Get a user by ID
mark_gift_message_as_read POST /api/2.0/portal/present/mark Mark a gift message as read
send_congratulations POST /api/2.0/portal/sendcongratulations Send congratulations
Rooms
Method HTTP request Description
RoomsApi
add_room_tags PUT /api/2.0/files/rooms/{id}/tags Add the room tags
archive_room PUT /api/2.0/files/rooms/{id}/archive Archive a room
change_room_cover POST /api/2.0/files/rooms/{id}/cover Change the room cover
create_room POST /api/2.0/files/rooms Create a room
create_room_from_template POST /api/2.0/files/rooms/fromtemplate Create a room from the template
create_room_logo POST /api/2.0/files/rooms/{id}/logo Create a room logo
create_room_tag POST /api/2.0/files/tags Create a room tag
create_room_template POST /api/2.0/files/roomtemplate Start creating room template
create_room_third_party POST /api/2.0/files/rooms/thirdparty/{id} Create a third-party room
delete_custom_tags DELETE /api/2.0/files/tags Delete the custom room tags
delete_room DELETE /api/2.0/files/rooms/{id} Remove a room
delete_room_logo DELETE /api/2.0/files/rooms/{id}/logo Remove a room logo
delete_room_tags DELETE /api/2.0/files/rooms/{id}/tags Remove the room tags
get_new_room_items GET /api/2.0/files/rooms/{id}/news Get the new room items
get_public_settings GET /api/2.0/files/roomtemplate/{id}/public Get public settings
get_room_covers GET /api/2.0/files/rooms/covers Get covers
get_room_creating_status GET /api/2.0/files/rooms/fromtemplate/status Get the room creation progress
get_room_index_export GET /api/2.0/files/rooms/indexexport Get the room index export
get_room_info GET /api/2.0/files/rooms/{id} Get room information
get_room_links GET /api/2.0/files/rooms/{id}/links Get the room links
get_room_security_info GET /api/2.0/files/rooms/{id}/share Get the room access rights
get_room_tags_info GET /api/2.0/files/tags Get the room tags
get_room_template_creating_status GET /api/2.0/files/roomtemplate/status Get status of room template creation
get_rooms_folder GET /api/2.0/files/rooms Get rooms
get_rooms_new_items GET /api/2.0/files/rooms/news Get the room new items
get_rooms_primary_external_link GET /api/2.0/files/rooms/{id}/link Get the room primary external link
pin_room PUT /api/2.0/files/rooms/{id}/pin Pin a room
reorder_room PUT /api/2.0/files/rooms/{id}/reorder Reorder the room
resend_email_invitations POST /api/2.0/files/rooms/{id}/resend Resend the room invitations
set_public_settings PUT /api/2.0/files/roomtemplate/public Set public settings
set_room_link PUT /api/2.0/files/rooms/{id}/links Set the room external or invitation link
set_room_security PUT /api/2.0/files/rooms/{id}/share Set the room access rights
start_room_index_export POST /api/2.0/files/rooms/{id}/indexexport Start the room index export
terminate_room_index_export DELETE /api/2.0/files/rooms/indexexport Terminate the room index export
unarchive_room PUT /api/2.0/files/rooms/{id}/unarchive Unarchive a room
unpin_room PUT /api/2.0/files/rooms/{id}/unpin Unpin a room
update_room PUT /api/2.0/files/rooms/{id} Update a room
upload_room_logo POST /api/2.0/files/logos Upload a room logo image
Security
Method HTTP request Description
AccessToDevToolsApi
set_tenant_dev_tools_access_settings POST /api/2.0/settings/devtoolsaccess Set the Developer Tools access settings
ActiveConnectionsApi
get_all_active_connections GET /api/2.0/security/activeconnections Get active connections
log_out_active_connection PUT /api/2.0/security/activeconnections/logout/{loginEventId} Log out from the connection
log_out_all_active_connections_change_password PUT /api/2.0/security/activeconnections/logoutallchangepassword Log out and change password
log_out_all_active_connections_for_user PUT /api/2.0/security/activeconnections/logoutall/{userId} Log out for the user by ID
log_out_all_except_this_connection PUT /api/2.0/security/activeconnections/logoutallexceptthis Log out from all connections except the current one
AuditTrailDataApi
create_audit_trail_report POST /api/2.0/security/audit/events/report Generate the audit trail report
get_audit_events_by_filter GET /api/2.0/security/audit/events/filter Get filtered audit trail data
get_audit_settings GET /api/2.0/security/audit/settings/lifetime Get the audit trail settings
get_audit_trail_mappers GET /api/2.0/security/audit/mappers Get audit trail mappers
get_audit_trail_types GET /api/2.0/security/audit/types Get audit trail types
get_last_audit_events GET /api/2.0/security/audit/events/last Get audit trail data
set_audit_settings POST /api/2.0/security/audit/settings/lifetime Set the audit trail settings
BannersVisibilityApi
set_tenant_banner_settings POST /api/2.0/settings/banner Set the banners visibility
CSPApi
configure_csp POST /api/2.0/security/csp Configure CSP settings
get_csp_settings GET /api/2.0/security/csp Get CSP settings
FirebaseApi
doc_register_pusn_notification_device POST /api/2.0/settings/push/docregisterdevice Save the Documents Firebase device token
subscribe_documents_push_notification PUT /api/2.0/settings/push/docsubscribe Subscribe to Documents push notification
LoginHistoryApi
create_login_history_report POST /api/2.0/security/audit/login/report Generate the login history report
get_last_login_events GET /api/2.0/security/audit/login/last Get login history
get_login_events_by_filter GET /api/2.0/security/audit/login/filter Get filtered login events
OAuth2Api
generate_jwt_token GET /api/2.0/security/oauth2/token Generate JWT token
SMTPSettingsApi
get_smtp_operation_status GET /api/2.0/smtpsettings/smtp/test/status Get the SMTP testing process status
get_smtp_settings GET /api/2.0/smtpsettings/smtp Get the SMTP settings
reset_smtp_settings DELETE /api/2.0/smtpsettings/smtp Reset the SMTP settings
save_smtp_settings POST /api/2.0/smtpsettings/smtp Save the SMTP settings
test_smtp_settings GET /api/2.0/smtpsettings/smtp/test Test the SMTP settings
Settings
Method HTTP request Description
AccessToDevToolsApi
get_tenant_access_dev_tools_settings GET /api/2.0/settings/devtoolsaccess Get the Developer Tools access settings
AuthorizationApi
get_auth_services GET /api/2.0/settings/authservice Get the authorization services
save_auth_keys POST /api/2.0/settings/authservice Save the authorization keys
BannersVisibilityApi
get_tenant_banner_settings GET /api/2.0/settings/banner Get the banners visibility
CommonSettingsApi
close_admin_helper PUT /api/2.0/settings/closeadminhelper Close the admin helper
complete_wizard PUT /api/2.0/settings/wizard/complete Complete the Wizard settings
configure_deep_link POST /api/2.0/settings/deeplink Configure the deep link settings
delete_portal_color_theme DELETE /api/2.0/settings/colortheme Delete a color theme
get_deep_link_settings GET /api/2.0/settings/deeplink Get the deep link settings
get_payment_settings GET /api/2.0/settings/payment Get the payment settings
get_portal_color_theme GET /api/2.0/settings/colortheme Get a color theme
get_portal_hostname GET /api/2.0/settings/machine Get hostname
get_portal_logo GET /api/2.0/settings/logo Get a portal logo
get_portal_settings GET /api/2.0/settings Get the portal settings
get_socket_settings GET /api/2.0/settings/socket Get the socket settings
get_supported_cultures GET /api/2.0/settings/cultures Get supported languages
get_tenant_user_invitation_settings GET /api/2.0/settings/invitationsettings Get the user invitation settings
get_time_zones GET /api/2.0/settings/timezones Get time zones
save_dns_settings PUT /api/2.0/settings/dns Save the DNS settings
save_mail_domain_settings POST /api/2.0/settings/maildomainsettings Save the mail domain settings
save_portal_color_theme PUT /api/2.0/settings/colortheme Save a color theme
update_email_activation_settings PUT /api/2.0/settings/emailactivation Update the email activation settings
update_invitation_settings PUT /api/2.0/settings/invitationsettings Update user invitation settings
CookiesApi
get_cookie_settings GET /api/2.0/settings/cookiesettings Get cookies lifetime
update_cookie_settings PUT /api/2.0/settings/cookiesettings Update cookies lifetime
EncryptionApi
get_storage_encryption_progress GET /api/2.0/settings/encryption/progress Get the storage encryption progress
get_storage_encryption_settings GET /api/2.0/settings/encryption/settings Get the storage encryption settings
start_storage_encryption POST /api/2.0/settings/encryption/start Start the storage encryption process
GreetingSettingsApi
get_greeting_settings GET /api/2.0/settings/greetingsettings Get greeting settings
get_is_default_greeting_settings GET /api/2.0/settings/greetingsettings/isdefault Check the default greeting settings
restore_greeting_settings POST /api/2.0/settings/greetingsettings/restore Restore the greeting settings
save_greeting_settings POST /api/2.0/settings/greetingsettings Save the greeting settings
IPRestrictionsApi
get_ip_restrictions GET /api/2.0/settings/iprestrictions Get the IP portal restrictions
read_ip_restrictions_settings GET /api/2.0/settings/iprestrictions/settings Get the IP restriction settings
save_ip_restrictions PUT /api/2.0/settings/iprestrictions Update the IP restrictions
update_ip_restrictions_settings PUT /api/2.0/settings/iprestrictions/settings Update the IP restriction settings
LicenseApi
accept_license POST /api/2.0/settings/license/accept Activate a license
get_is_license_required GET /api/2.0/settings/license/required Request a license
refresh_license GET /api/2.0/settings/license/refresh Refresh the license
upload_license POST /api/2.0/settings/license Upload a license
LoginSettingsApi
get_login_settings GET /api/2.0/settings/security/loginsettings Get the login settings
set_default_login_settings DELETE /api/2.0/settings/security/loginsettings Reset the login settings
update_login_settings PUT /api/2.0/settings/security/loginsettings Update the login settings
MessagesApi
enable_admin_message_settings POST /api/2.0/settings/messagesettings Enable the administrator message settings
send_admin_mail POST /api/2.0/settings/sendadmmail Send a message to the administrator
send_join_invite_mail POST /api/2.0/settings/sendjoininvite Sends an invitation email
NotificationsApi
get_notification_channels GET /api/2.0/settings/notification/channels Get notification channels
get_notification_settings GET /api/2.0/settings/notification/{type} Check notification availability
get_rooms_notification_settings GET /api/2.0/settings/notification/rooms Get room notification settings
set_notification_settings POST /api/2.0/settings/notification Enable notifications
set_rooms_notification_status POST /api/2.0/settings/notification/rooms Set room notification status
OwnerApi
send_owner_change_instructions POST /api/2.0/settings/owner Send the owner change instructions
update_portal_owner PUT /api/2.0/settings/owner Update the portal owner
QuotaApi
get_user_quota_settings GET /api/2.0/settings/userquotasettings Get the user quota settings
save_ai_agent_quota_settings POST /api/2.0/settings/aiagentquotasettings Save the AI Agent quota settings
save_room_quota_settings POST /api/2.0/settings/roomquotasettings Save the room quota settings
set_tenant_quota_settings PUT /api/2.0/settings/tenantquotasettings Save the tenant quota settings
RebrandingApi
delete_additional_white_label_settings DELETE /api/2.0/settings/rebranding/additional Delete the additional white label settings
delete_company_white_label_settings DELETE /api/2.0/settings/rebranding/company Delete the company white label settings
get_additional_white_label_settings GET /api/2.0/settings/rebranding/additional Get the additional white label settings
get_company_white_label_settings GET /api/2.0/settings/rebranding/company Get the company white label settings
get_enable_whitelabel GET /api/2.0/settings/enablewhitelabel Check the white label availability
get_is_default_white_label_logo_text GET /api/2.0/settings/whitelabel/logotext/isdefault Check the default white label logo text
get_is_default_white_label_logos GET /api/2.0/settings/whitelabel/logos/isdefault Check the default white label logos
get_licensor_data GET /api/2.0/settings/companywhitelabel Get the licensor data
get_white_label_logo_text GET /api/2.0/settings/whitelabel/logotext Get the white label logo text
get_white_label_logos GET /api/2.0/settings/whitelabel/logos Get the white label logos
restore_white_label_logo_text PUT /api/2.0/settings/whitelabel/logotext/restore Restore the white label logo text
restore_white_label_logos PUT /api/2.0/settings/whitelabel/logos/restore Restore the white label logos
save_additional_white_label_settings POST /api/2.0/settings/rebranding/additional Save the additional white label settings
save_company_white_label_settings POST /api/2.0/settings/rebranding/company Save the company white label settings
save_white_label_logo_text POST /api/2.0/settings/whitelabel/logotext/save Save the white label logo text settings
save_white_label_settings POST /api/2.0/settings/whitelabel/logos/save Save the white label logos
save_white_label_settings_from_files POST /api/2.0/settings/whitelabel/logos/savefromfiles Save the white label logos from files
SSOApi
get_default_sso_settings_v2 GET /api/2.0/settings/ssov2/default Get the default SSO settings
get_sso_settings_v2 GET /api/2.0/settings/ssov2 Get the SSO settings
get_sso_settings_v2_constants GET /api/2.0/settings/ssov2/constants Get the SSO settings constants
reset_sso_settings_v2 DELETE /api/2.0/settings/ssov2 Reset the SSO settings
save_sso_settings_v2 POST /api/2.0/settings/ssov2 Save the SSO settings
SecurityApi
get_enabled_modules GET /api/2.0/settings/security/modules Get the enabled modules
get_is_product_administrator GET /api/2.0/settings/security/administrator Check a product administrator
get_password_settings GET /api/2.0/settings/security/password Get the password settings
get_product_administrators GET /api/2.0/settings/security/administrator/{productid} Get the product administrators
get_web_item_security_info GET /api/2.0/settings/security/{id} Get the module availability
get_web_item_settings_security_info GET /api/2.0/settings/security Get the security settings
set_access_to_web_items PUT /api/2.0/settings/security/access Set the security settings to modules
set_product_administrator PUT /api/2.0/settings/security/administrator Set a product administrator
set_web_item_security PUT /api/2.0/settings/security Set the module security settings
update_password_settings PUT /api/2.0/settings/security/password Set the password settings
StatisticsApi
get_space_usage_statistics GET /api/2.0/settings/statistics/spaceusage/{id} Get the space usage statistics
StorageApi
get_all_backup_storages GET /api/2.0/settings/storage/backup Get the backup storages
get_all_cdn_storages GET /api/2.0/settings/storage/cdn Get the CDN storages
get_all_storages GET /api/2.0/settings/storage Get storages
get_amazon_s3_regions GET /api/2.0/settings/storage/s3/regions Get Amazon regions
get_storage_progress GET /api/2.0/settings/storage/progress Get the storage progress
reset_cdn_to_default DELETE /api/2.0/settings/storage/cdn Reset the CDN storage settings
reset_storage_to_default DELETE /api/2.0/settings/storage Reset the storage settings
update_cdn_storage PUT /api/2.0/settings/storage/cdn Update the CDN storage
update_storage PUT /api/2.0/settings/storage Update a storage
TFASettingsApi
get_tfa_app_codes GET /api/2.0/settings/tfaappcodes Get the TFA codes
get_tfa_confirm_url GET /api/2.0/settings/tfaapp/confirm Get confirmation email
get_tfa_settings GET /api/2.0/settings/tfaapp Get the TFA settings
tfa_app_generate_setup_code GET /api/2.0/settings/tfaapp/setup Generate setup code
tfa_validate_auth_code POST /api/2.0/settings/tfaapp/validate Validate the TFA code
unlink_tfa_app PUT /api/2.0/settings/tfaappnewapp Unlink the TFA application
update_tfa_app_codes PUT /api/2.0/settings/tfaappnewcodes Update the TFA codes
update_tfa_settings PUT /api/2.0/settings/tfaapp Update the TFA settings
update_tfa_settings_link PUT /api/2.0/settings/tfaappwithlink Get a confirmation email for updating TFA settings
TelegramApi
check_telegram GET /api/2.0/settings/telegram/check Check the Telegram connection
link_telegram GET /api/2.0/settings/telegram/link Get the Telegram link
unlink_telegram DELETE /api/2.0/settings/telegram/link Unlink Telegram
WebhooksApi
create_webhook POST /api/2.0/settings/webhook Create a webhook
enable_webhook PUT /api/2.0/settings/webhook/enable Enable a webhook
get_tenant_webhooks GET /api/2.0/settings/webhook Get webhooks
get_webhook_triggers GET /api/2.0/settings/webhook/triggers Get webhook triggers
get_webhooks_logs GET /api/2.0/settings/webhooks/log Get webhook logs
remove_webhook DELETE /api/2.0/settings/webhook/{id} Remove a webhook
retry_webhook PUT /api/2.0/settings/webhook/{id}/retry Retry a webhook
retry_webhooks PUT /api/2.0/settings/webhook/retry Retry webhooks
update_webhook PUT /api/2.0/settings/webhook Update a webhook
WebpluginsApi
add_web_plugin_from_file POST /api/2.0/settings/webplugins Add a web plugin
delete_web_plugin DELETE /api/2.0/settings/webplugins/{name} Delete a web plugin
get_web_plugin GET /api/2.0/settings/webplugins/{name} Get a web plugin by name
get_web_plugins GET /api/2.0/settings/webplugins Get web plugins
update_web_plugin PUT /api/2.0/settings/webplugins/{name} Update a web plugin
ThirdParty
Method HTTP request Description
ThirdPartyApi
get_third_party_code GET /api/2.0/thirdparty/{provider} Get the code request

Documentation For Models

Models list

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for AscensioSystemSIA from gravatar.com AscensioSystemSIA

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache-2.0)
  • Author: Ascensio System SIA
  • Tags onlyoffice , docspace , sdk
  • Requires: Python <4.0, >=3.9
Classifiers

Release history Release notifications | RSS feed

This version

3.6.0

3.5.1

3.5.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docspace_api_sdk-3.6.0.tar.gz (426.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docspace_api_sdk-3.6.0-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file docspace_api_sdk-3.6.0.tar.gz.

File metadata

  • Download URL: docspace_api_sdk-3.6.0.tar.gz
  • Upload date:
  • Size: 426.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for docspace_api_sdk-3.6.0.tar.gz
Algorithm Hash digest
SHA256 32e27474a37984f24e15fabee7c3a5b0ca419dc2aa2a9548c85143ee17cce521
MD5 7077e22a0544d3631858804e0cca7530
BLAKE2b-256 90bd5b40087f00f39792fcd75318e1405a970c1b29ac9b0950532136cf5c2f57

See more details on using hashes here.

File details

Details for the file docspace_api_sdk-3.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for docspace_api_sdk-3.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 743f8768e2d19a433ade49eac32aaa5584be97097de9c62c452788654554a2ff
MD5 e4fb10b4e5475926386151a9e35624cf
BLAKE2b-256 6c3d12f9648e072d27cdac9705b315c6f614335face22da94d4cd648526b0077

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page