ONLYOFFICE DocSpace Group 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.

Group

Method	HTTP request	Description
addGroup	POST /api/2.0/group	Add a new group
addMembersTo	PUT /api/2.0/group/{id}/members	Add group members
deleteGroup	DELETE /api/2.0/group/{id}	Delete a group
getGroup	GET /api/2.0/group/{id}	Get a group
getGroupByUserId	GET /api/2.0/group/user/{userId}	Get user groups
getGroups	GET /api/2.0/group	Get groups
moveMembersTo	PUT /api/2.0/group/{fromId}/members/{toId}	Move group members
removeMembersFrom	DELETE /api/2.0/group/{id}/members	Remove group members
setGroupManager	PUT /api/2.0/group/{id}/manager	Set a group manager
setMembersTo	POST /api/2.0/group/{id}/members	Replace group members
updateGroup	PUT /api/2.0/group/{id}	Update a group

Search

Method	HTTP request	Description
getGroupsWithFilesShared	GET /api/2.0/group/file/{id}	Search groups for a file
getGroupsWithFoldersShared	GET /api/2.0/group/folder/{id}	Search groups for a folder
getGroupsWithRoomsShared	GET /api/2.0/group/room/{id}	Search groups for a room

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: