ONLYOFFICE DocSpace OAuth 2.0 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.

Authorization

Method	HTTP request	Description
authorizeOAuth	GET /oauth2/authorize	Start the authorization flow
exchangeToken	POST /oauth2/token	Exchange the authorization code
submitConsent	POST /oauth2/authorize	Submit the consent decision

Client Management

Method	HTTP request	Description
changeActivation	PATCH /api/2.0/oauth2/clients/{clientId}/activation	Change client activation status
createClient	POST /api/2.0/oauth2/clients	Create a new OAuth2 client
deleteClient	DELETE /api/2.0/oauth2/clients/{clientId}	Delete an OAuth2 client
deleteTenantClients	DELETE /api/2.0/oauth2/clients/tenant	Delete all tenant OAuth2 clients
deleteUserClients	DELETE /api/2.0/oauth2/clients	Delete all user OAuth2 clients
regenerateSecret	PATCH /api/2.0/oauth2/clients/{clientId}/regenerate	Regenerate client secret
revokeUserClient	DELETE /api/2.0/oauth2/clients/{clientId}/revoke	Revoke client consent
updateClient	PUT /api/2.0/oauth2/clients/{clientId}	Update an existing OAuth2 client

Client Querying

Method	HTTP request	Description
getClient	GET /api/2.0/oauth2/clients/{clientId}	Get client details
getClientInfo	GET /api/2.0/oauth2/clients/{clientId}/info	Get client info
getClients	GET /api/2.0/oauth2/clients	List clients
getClientsInfo	GET /api/2.0/oauth2/clients/info	List client info
getConsents	GET /api/2.0/oauth2/clients/consents	List user consents
getPublicClientInfo	GET /api/2.0/oauth2/clients/{clientId}/public/info	Get public client info

Discovery

Method	HTTP request	Description
handleOptions	OPTIONS /.well-known/oauth-authorization-server	Probe the discovery endpoint

Scope Management

Method	HTTP request	Description
getScopes	GET /api/2.0/oauth2/scopes	List available OAuth2 scopes

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: