ONLYOFFICE DocSpace People API

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

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

Email

Method	HTTP request	Description
changeUserEmail	PUT /api/2.0/people/{userId}/email	Change a user email
sendEmailChangeInstructions	POST /api/2.0/people/email	Send instructions to change email

Guests

Method	HTTP request	Description
approveGuestShareLink	POST /api/2.0/people/guests/share/approve	Approve a guest sharing link
deleteGuests	DELETE /api/2.0/people/guests	Remove guest relations

Password

Method	HTTP request	Description
changeUserPassword	PUT /api/2.0/people/{userId}/password	Change a user password
sendUserPassword	POST /api/2.0/people/password	Remind a user password

Photos

Method	HTTP request	Description
createMemberPhotoThumbnails	POST /api/2.0/people/{userId}/photo/thumbnails	Create photo thumbnails
deleteMemberPhoto	DELETE /api/2.0/people/{userId}/photo	Delete a user photo
getMemberPhoto	GET /api/2.0/people/{userId}/photo	Get a user photo
updateMemberPhoto	PUT /api/2.0/people/{userId}/photo	Update a user photo
uploadMemberPhoto	POST /api/2.0/people/{userId}/photo	Upload a user photo

Profiles

Method	HTTP request	Description
addMember	POST /api/2.0/people	Add a user
checkUserExistsByEmail	GET /api/2.0/people/exists	Check whether an email is taken
deleteMember	DELETE /api/2.0/people/{userId}	Delete a user
deleteProfile	DELETE /api/2.0/people/@self	Close my own profile
getAllProfiles	GET /api/2.0/people	Get the active profiles
getClaims	GET /api/2.0/people/tokendiagnostics	Get user claims
getProfileByEmail	GET /api/2.0/people/email	Get a profile by user email
getProfileByUserId	GET /api/2.0/people/{userId}	Get a profile by user ID
getSelfProfile	GET /api/2.0/people/@self	Get my profile
inviteUsers	POST /api/2.0/people/invite	Invite users
removeUsers	PUT /api/2.0/people/delete	Delete users
resendUserInvites	PUT /api/2.0/people/invite	Resend activation emails
updateMember	PUT /api/2.0/people/{userId}	Update a user
updateMemberCulture	PUT /api/2.0/people/{userId}/culture	Update a user culture

Quota

Method	HTTP request	Description
resetUsersQuota	PUT /api/2.0/people/resetquota	Reset a user quota limit
updateUserQuota	PUT /api/2.0/people/userquota	Change a user quota limit

Search

Method	HTTP request	Description
getAccountsEntriesWithFilesShared	GET /api/2.0/accounts/file/{id}/search	Search accounts for a file
getAccountsEntriesWithFoldersShared	GET /api/2.0/accounts/folder/{id}/search	Search accounts for a folder
getAccountsEntriesWithRoomsShared	GET /api/2.0/accounts/room/{id}/search	Search accounts for a room
getSearch	GET /api/2.0/people/@search/{query}	Search users
getSimpleByFilter	GET /api/2.0/people/simple/filter	Filter users in brief
getUsersWithFilesShared	GET /api/2.0/people/file/{id}	Search users for a file
getUsersWithFoldersShared	GET /api/2.0/people/folder/{id}	Search users for a folder
getUsersWithRoomShared	GET /api/2.0/people/room/{id}	Search users for a room
searchUsersByExtendedFilter	GET /api/2.0/people/filter	Filter users in detail
searchUsersByQuery	GET /api/2.0/people/search	Search users by query
searchUsersByStatus	GET /api/2.0/people/status/{status}/search	Search users by status filter

Theme

Method	HTTP request	Description
changePortalTheme	PUT /api/2.0/people/theme	Change the portal theme
getPortalTheme	GET /api/2.0/people/theme	Get the portal theme

Third-party accounts

Method	HTTP request	Description
getThirdPartyAuthProviders	GET /api/2.0/people/thirdparty/providers	Get third-party providers
linkThirdPartyAccount	PUT /api/2.0/people/thirdparty/linkaccount	Link a third-party account
signupThirdPartyAccount	POST /api/2.0/people/thirdparty/signup	Sign up with a provider
unlinkThirdPartyAccount	DELETE /api/2.0/people/thirdparty/unlinkaccount	Unlink a third-party account

User data

Method	HTTP request	Description
getDeletePersonalFolderProgress	GET /api/2.0/people/delete/personal/progress	Get the personal folder deletion progress
getReassignProgress	GET /api/2.0/people/reassign/progress/{userId}	Get the reassignment progress
getRemoveProgress	GET /api/2.0/people/remove/progress/{userId}	Get the deletion progress
necessaryReassign	GET /api/2.0/people/reassign/necessary	Check data for reassignment need
sendInstructionsToDelete	PUT /api/2.0/people/self/delete	Send the deletion instructions
startDeletePersonalFolder	POST /api/2.0/people/delete/personal/start	Delete the personal folder
startReassign	POST /api/2.0/people/reassign/start	Start the data reassignment
startRemove	POST /api/2.0/people/remove/start	Start the data deletion
terminateReassign	PUT /api/2.0/people/reassign/terminate	Terminate the data reassignment
terminateRemove	PUT /api/2.0/people/remove/terminate	Terminate the data deletion

User status

Method	HTTP request	Description
getByStatus	GET /api/2.0/people/status/{status}	Get profiles by status
updateUserActivationStatus	PUT /api/2.0/people/activationstatus/{activationStatus}	Set my activation status
updateUserStatus	PUT /api/2.0/people/status/{status}	Change a user status

User type

Method	HTTP request	Description
getUserTypeUpdateProgress	GET /api/2.0/people/type/progress/{userId}	Get the user type change progress
startUserTypeUpdate	POST /api/2.0/people/type	Start updating user type
terminateUserTypeUpdate	PUT /api/2.0/people/type/terminate	Terminate updating user type
updateUserType	PUT /api/2.0/people/type/{type}	Change a user type

Authorization

cookieAuth

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

bearerAuth

• Type: HTTP Bearer Token authentication

asc_auth_key

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

Basic

• Type: HTTP basic authentication

Bearer

• Type: HTTP Bearer Token authentication (JWT)

ApiKeyBearer

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

OAuth2

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

OpenId

x-signature

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