Grouper Web Services

Description

Group save will insert or update a group's uuid, extension, display name, or description (with restrictions).  Note: the group displayName and extension are not used in a groupSave.  That information is used from the group name, and displayExtension.  Note, when you call a groupSave, You need to send in all the attributes.  Might want to get the group, edit what you want, and send back.

Features

Group save Lite service

Group save service

FAQ

Move or copy group

Send in a wsGroupLookup, and no wsGroup.  This will return SUCCESS_INSERTED if successful

Note, the documentation below is copied from the move/copy documentation which is most of up to date

Params (note param indexes passed in should be sequential starting with 0)

This will return the destination stem with the extension of the Group (which may or may not be the group that was copied)

ParamValueNotes
[--paramName0=moveOrCopy] [--paramValue0=copy]move|copy
[--paramName1=moveOrCopyToStemUuid] [--paramValue1=abc123]uuid of a stem to move or copy tomutually exclusive with moveOrCopyStemName and moveOrCopyToStemIdIndex
[--paramName2=moveOrCopyToStemName] [--paramValue2=a:b:c]name of stem to move or copy tomutually exclusive with moveOrCopyStemUuid and moveOrCopyToStemIdIndex
[--paramName3=moveOrCopyToStemIdIndex] [--paramValue3=19]id index of stem to move or copy tomutually exclusive with moveOrCopyStemUuid and moveOrCopyStemName
[--paramName4=copyPrivilegesOfGroup] [--paramValue4=true]true|falseWhether to copy the access privileges of the group.  
If this option is selected, you must have READ access to all privileges. 
[--paramName5=copyGroupAsPrivilege] [--paramValue5=true]true|falseWhether to copy access and naming privileges where the group is a member.  
For instance, if you are copying Group X and Group X has admin privileges
to Group Y, then if this option is enabled, after Group X is copied, the new
group will also have admin privileges to Group Y.  If this option is selected,
you must have access to add privileges to the other groups and folders. 
[--paramName6=copyListMembersOfGroup ] [--paramValue6=true]true|falseWhether to copy list memberships of the group.  If this option is selected
and this group has custom lists, you must have read access to them. 
[--paramName7=copyListGroupAsMember ] [--paramValue7=true]true|falseWhether to copy list memberships where the group is a member.  
For instance, if you are copying Group X and Group X is a member of
Group Y, then if this option is enabled, after Group X is copied, the
new group will also be a member of Group Y.  If this option is selected,
you must have access to add memberships to the other groups.
[--paramName8=copyAttributes ] [--paramValue8=true]true|falseWhether to copy attributes.  If this option is selected, you must have READ
access to all attributes.  These are attributes that are added to GroupTypes. 
This does not include attributes in the new attribute framework in v1.5.0.
[--paramName9=moveAssignAlternateName ] [--paramValue9=true]true|falseWhether to assign the old name of the group as an alternate name of
the group after the move.  This allows API methods like GroupFinder.findByName()
to find the group using the old and new names and can make it easier to transition
from the old name to the new name. 

Example

<WsRestGroupSaveRequest>
  <wsGroupToSaves>
    <WsGroupToSave>
      <wsGroupLookup>
        <groupName>test:testGroupToCopy</groupName>
      </wsGroupLookup>
      <wsGroup>
        <displayExtension>testGroupToCopy</displayExtension>
        <name>test:testGroupToCopy</name>
      </wsGroup>
    </WsGroupToSave>
  </wsGroupToSaves>
  <params>
    <WsParam>
      <paramName>moveOrCopy</paramName>
      <paramValue>copy</paramValue>
    </WsParam>
    <WsParam>
      <paramName>moveOrCopyToStemName</paramName>
      <paramValue>test:stemDestination</paramValue>
    </WsParam>
    <WsParam>
      <paramName>copyPrivilegesOfGroup</paramName>
      <paramValue>true</paramValue>
    </WsParam>
    <WsParam>
      <paramName>copyGroupAsPrivilege</paramName>
      <paramValue>true</paramValue>
    </WsParam>
    <WsParam>
      <paramName>copyListMembersOfGroup</paramName>
      <paramValue>true</paramValue>
    </WsParam>
    <WsParam>
      <paramName>copyListGroupAsMember</paramName>
      <paramValue>true</paramValue>
    </WsParam>
    <WsParam>
      <paramName>copyAttributes</paramName>
      <paramValue>true</paramValue>
    </WsParam>
  </params>
</WsRestGroupSaveRequest>


Rename group

You have the option to not set the alternateName during a group rename by using the param renameAssignAlternateName (true/false)


<WsRestGroupSaveRequest>
   <wsGroupToSaves>
      <WsGroupToSave>
         <wsGroupLookup>
            <groupName>d:oldName</groupName>
         </wsGroupLookup>
         <wsGroup>
            <name>d:newName</name>
         </wsGroup>
      </WsGroupToSave>
   </wsGroupToSaves>
   <params>
      <WsParam>
         <paramName>renameAssignAlternateName</paramName>
         <paramValue>false</paramValue>
      </WsParam>
   </params>
</WsRestGroupSaveRequest>



sdf