Get Started
Portal api methods
Help

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

Description

Set security settings for product, module or addons

Parameters
Name Description Type Example
id
sent in body
Module ID string some text
enabled
sent in body
Enabled Bool value true
subjects
sent in body
User (Group) ID list Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
Example
PUT api/2.0/settings/security
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "id": "some text",
  "enabled": true,
  "subjects": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Returns

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "webItemId": "00000000-0000-0000-0000-000000000000",
      "users": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "displayName": "Mike Zanyatski",
          "title": "Manager",
          "avatarSmall": "url to small avatar",
          "profileUrl": ""
        }
      ],
      "groups": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Group Name",
          "manager": "Jake.Zazhitski"
        }
      ],
      "enabled": true,
      "isSubItem": false
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <webItemId>00000000-0000-0000-0000-000000000000</webItemId>
    <users>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </users>
    <groups>
      <id>00000000-0000-0000-0000-000000000000</id>
      <name>Group Name</name>
      <manager>Jake.Zazhitski</manager>
    </groups>
    <enabled>true</enabled>
    <isSubItem>false</isSubItem>
  </response>
</result>