Get the security settings

GET /api/2.0/settings/security

Request

Returns the security settings for the modules specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Query

idsarray of unknown

List of module IDs

Examples

GET /api/2.0/settings/security?ids=%5B%22some%20text%22%5D HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url 'https://example.com/api/2.0/settings/security?ids=%5B%22some%20text%22%5D' \
  --header 'Accept: application/json'

Responses

200

Security settings

webItemIdstring

Module ID

usersarray of unknown

List of users with the access to the module

groupsarray of unknown

List of groups with the access to the module

enabledboolean

Specifies if the security settings are enabled or not

isSubItemboolean

Specifies if this module is a subitem or not

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).