Skip to end of metadata
Go to start of metadata

Update a group

Resource

  • PUT| (root)/group/{group_identifier}
  1. The group_identifier can be a group name (cn) or a regid.
  2. The request must contain an If-Match header.
  3. You may specify a wild-card header: If-Match: *

Upload data

  1. This is similar to the upload for Create group.
  2. Upload content must contain one class "group".  
  3. Formatting  html is ignored. 
  4. The content can be similar to that of a GET request.
  5. Only one name (cn) may be specified.
  6. You cannot change the stem of the group's cn. For that use Rename-Move.
  7. You must specify at least one Administrator.
  8. An ACL identifier of "dc=all" (type="none") means everyone.
  9. An ACL identifier of "dc=none" (type="none") means no one.
  10. Omitted ACLs do NOT preserve existing values
  11. If email is enabled, the Contact field must be present and non-null.
  12. Version 2
    1. You may specify an authnfactor, but it will be ignored.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11/dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
</head>
<body>
  <div class="group">
    Regid: <span class="regid">Group's regid</span>

    Desc: <span class="description">Group's description</span>

    <ul class="names">
     <li class="name">Group_name</li>
    </ul>

    <!-- version v2 and greater -->
       Authn factor: <span class="authnfactor">1|2</span>
       <br/>
       Classification: <span class="classification">u|p|r|c</span>
       <br/>
       Membership dependency group: <span class="dependson">dependency group cn</span>
       <br/>
    <!-- end v2 -->



    <!-- The enabled flag is "UWExchange" or "disabled" -->
    Email Enabled: <span class="emailenabled">UWExchange</span>

    Published email address: <span class="publishemail">email_address</span>

    Allowed senders:
    <ul class="authorigs">
       <li class="authorig">sender id</li>
       <!-- More (li) if there are multiple allowed senders -->
    </ul>
    Report to originator: <span class="reporttoorig">0 or 1</span>

    Group contact: <span class="contact">contact id</span>

    Admins:
    <ul class="admins">
    <li class="admin" type="(type)">identifier</li>
     <!-- More (li) if the group has more admins -->
    </ul>
    <br/>

    Allowed updaters:
    <ul class="updaters">
    <li class="updater" type="(type)">identifier</li>
     <!-- More (li) if the group has multiple updaters -->
    </ul>
    <br/>

    Allowed creators:
    <ul class="creators">
    <li class="creator" type="(type)">identifier</li>
     <!-- More (li) if the group has multiple creators -->
    </ul>
    <br/>


    Allowed readers
    <ul class="readers">
    <li class="reader" type="(type)">identifier</li>
     <!-- More (li) if the group has multiple readers -->
    </ul>
    <br/>


    Allowed viewers:
    <ul class="viewers">
    <li class="viewer" type="(type)">identifier</li>
     <!-- More (li) if the group has multiple viewers -->
    </ul>
    <br/>


    <!-- version v2 and greater -->
      Allowed optin:
      <ul class="optins">
       <li class="optin" type="(type)">identifier</li>
       <!-- More (li) if the group has multiple optins -->
      </ul>
      <br/>
      Allowed optout:
      <ul class="optouts">
       <li class="optout" type="(type)">identifier</li>
       <!-- More (li) if the group has multiple optouts -->
      </ul>
      <br/>
    <!-- end v2 -->

    <a rel="members" href="(root)/group/{regid}/member">members</a>
   </div>
</body>
</html>

Return

200

Content is the same as for a GET.

400

Invalid xhtml in the upload data.

 

Email-enabled, no contact

401

No authorization.

409

Invalid regid

 

Group names did not match the name in the URL

412

Incorect  If-Match header data

Notes

  1. The response always includes an ETag header, which can be used on subsequent GETs and must be used on subsequent updates or deletes.