Get Started
Usage API
More information

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

Description

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

Parameters
Name Description Type Example
ids
sent in url
List of module IDs Collection of strings
collection
some text
Example
GET api/2.0/settings/security?ids=%5b%0d%0a++%22some+text%22%0d%0a%5d
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Security settings

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": "\\/Products\\/People\\/Profile.aspx?user=administrator"
        }
      ],
      "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>\/Products\/People\/Profile.aspx?user=administrator</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>