Set the access settings to products

PUT /api/2.0/settings/security/access

Request

Sets the access settings to the products with the IDs 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.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Module request parameters

itemsobject

Products with security information

Examples

PUT /api/2.0/settings/security/access HTTP/1.1
Accept: application/json
Content-Length: 78
Content-Type: application/json
Host: example.com

{
  "items": [
    {
      "key": "some text",
      "value": true
    }
  ]
}
curl --request PUT \
  --url https://example.com/api/2.0/settings/security/access \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "items": [
    {
      "key": "some text",
      "value": true
    }
  ]
}'

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).