Get Started
API backend
API system
More information

PUT api/2.0/settings/security This function requires authentication

Description

Sets the security settings to the module with the ID specified in the request.

Parameters
Name Description Type Example
Id
sent in body
Module ID System.String
Enabled
sent in body
Specifies if the module security settings are enabled or not System.Boolean
Subjects
sent in body
List of user/group IDs with the access to the module System.Collections.Generic.IEnumerable{System.Guid}
Items
sent in body
Products with security information System.Collections.Generic.IEnumerable{ASC.Api.Collections.ItemKeyValuePair{System.String
Example
PUT api/2.0/settings/security
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "Id": "some text",
  "Enabled": true,
  "Subjects": [
    "9924256A-739C-462b-AF15-E652A3B1B6EB"
  ]
}
Returns

Security settings

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "WebItemId": "some text",
      "Enabled": true,
      "IsSubItem": true
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <WebItemId>some text</WebItemId>
    <Enabled>True</Enabled>
    <IsSubItem>True</IsSubItem>
  </response>
</result>