Updating Security Settings of a Content Item

You can update security settings of a content item with the updateContentItemPermissions method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
contentItemId (required) string ID of the content item, which security settings you want to update.
privacy (required) string Public or private
isViewedOnce (optional) bool True, if a given private content item can be viewed only once.
users (optional) string[] An array of user IDs, who are allowed to view a given private content item.
groups (optional) string[] An array of group IDs, which members are allowed to view a given private content item.

Return Value

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

Parameter Type Description
success bool True, if security settings of a given content item have been updated.

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>
    <UpdateContentItemPermissionsRequest 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>
      <Privacy>private</Privacy>
      <isViewedOnce>False</isViewedOnce>
      <Users>
        <id>1</id>
        <id>2</id>
      </Users>
      <Groups>
        <id>1</id>
        <id>2</id>
      </Groups>
    </UpdateContentItemPermissionsRequest>
  </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>
    <UpdateContentItemPermissionsResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Success>True</Success>
    </UpdateContentItemPermissionsResult>
  </soap:Body>
</soap:Envelope>