Getting Security Settings of a Content Item

You can get security settings of a content item with the getContentItemPermissions method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
contentItemId (required) string ID of a content item, which security settings you want to get.

Return Value

After the request has been completed, the system returns an object with the following properties:

Parameter Type Description
privacy string Content item type (public or private)
isViewedOnce bool True, if a given content item can be viewed only once.
users string[] An array of user IDs, who have permissions to view a given private content item.
groups string[] An array of group IDs, which members have permissions to view a given private content item.

Sample Call

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContentItemPermissionsRequest xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Credentials>
        <AccountUrl>http://myaccount.ispringonline.com</EmailAddress>
        <Email>email@email.com</Password>
        <Password>password</Password>
      </Credentials>
      <ContentItemId>1234</ContentItemId>
    </GetContenteItemPermissionsRequest>
  </soap:Body>
</soap:Envelope>

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContenteItemPermissionsResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Privacy>private</Privacy>
      <isViewedOnce>False</isViewedOnce>
      <Users>
        <id>1</id>
        <id>2</id>
      </Users>
      <Groups>
        <id>1</id>
        <id>2</id>
      </Groups>
    </GetContenteItemPermissionsResult>
  </soap:Body>
</soap:Envelope>