UpdateGroups

Description

This services updates one or more existing groups.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
allowEmptyValues	boolean	Specify true in order to honor empty values that are sent in the group argument. (This removes the current value that is specified on the group account). Default is false.
group (required)	GroupInfo	Used to identify a specific group or list of groups for update. Specify multiple group arguments to update multiple groups.
options	MultipleOptions	Holds name value pairing for future elements and enumeration to determine if the service should stop on failure and send an error message or continue processing.

Response

GroupHolder is returned. The GroupHolder response contains one or more GroupIdentifiers and additional information from the groups record. For more specific information, see GroupHolder.

Usage

Use the UpdateGroups call when you need to update one or more groups in SBM. Use the following arguments to handle how groups are updated by the service:

allowEmptyValues – Enables you to send an empty value in the group argument that is honored by the update. For example, if you need to remove the memo for one or more groups, set allowEmptyValues to true and send an empty value in the group element of each group argument you send. The default value is false, which means that empty values in the group argument are not honored.
CAUTION:
Use care when updating existing group accounts. Important group information might be mistakenly altered or removed if an existing group match is found and the group parameters you send are incorrect or empty. For example, to delete the memo for one or more groups, do not just clear the memo value and set allowEmptyValues to true. This will remove all the other group settings including the product access (which will be set to None if you send an empty value). When you want to clear values using allowEmptyValues, you must also provide values for elements in GroupInfo that you want to preserve
group – Enables you to specify one or more specific group accounts to be updated. If you want to update multiple groups, you must specify each desired group by providing the GroupIdentifier in a list of multiple group arguments. To delete groups, specify true in the isDeleted element of the group argument.

Faults

Invalid database pointer.
The user ID is not valid.
The user lacks sufficient permission.

XML

The following XML is a snippet of the payload this is sent with UpdateGroups.

<urn:UpdateGroups>
   <urn:auth>
      <urn:userId>admin</urn:userId>
      <urn:password></urn:password>
      <urn:hostname></urn:hostname>
      <urn:loginAsUserId></urn:loginAsUserId>
   </urn:auth>
   <urn:allowEmptyValues>false</urn:allowEmptyValues>
   <urn:group>
      <urn:id>
         <urn:displayName>CR Submitters</urn:displayName>
         <urn:id></urn:id>
         <urn:uuid></urn:uuid>
      </urn:id>
      <urn:accessType>ACCESS-ADMIN</urn:accessType>
      <urn:memo>Changed this group to admin access.</urn:memo>
      <urn:isDeleted></urn:isDeleted>
   </urn:group>
   <urn:group>
      <urn:id>
         <urn:displayName>IDM Team</urn:displayName>
         <urn:id></urn:id>
         <urn:uuid></urn:uuid>
      </urn:id>
      <urn:accessType>ACCESS-USER</urn:accessType>
      <urn:memo>This team has user access now.</urn:memo>
      <urn:isDeleted></urn:isDeleted>
   </urn:group>
   <urn:options>
      <urn:multiOption>CONTINUE-ON-FAILURE</urn:multiOption>
   </urn:options>
</urn:UpdateGroups>

In this example, the current memo is deleted on the CR Submitters group:

<urn:UpdateGroups>
   <urn:auth>
      <urn:userId>admin</urn:userId>
      <urn:password></urn:password>
      <urn:hostname></urn:hostname>
      <urn:loginAsUserId></urn:loginAsUserId>
   </urn:auth>
   <urn:allowEmptyValues>true</urn:allowEmptyValues>
   <urn:group>
      <urn:id>
         <urn:displayName>CR Submitters</urn:displayName>
      </urn:id>
      <urn:accessType>ACCESS-ADMIN</urn:accessType>
      <urn:memo></urn:memo>
      <urn:isDeleted></urn:isDeleted>
   </urn:group>
   <urn:options>
      <urn:multiOption>CONTINUE-ON-FAILURE</urn:multiOption>
   </urn:options>
</urn:UpdateGroups>

In this example, the CR Submitters group is deleted:

<urn:UpdateGroups>
   <urn:auth>
      <urn:userId>admin</urn:userId>
      <urn:password></urn:password>
      <urn:hostname></urn:hostname>
      <urn:loginAsUserId></urn:loginAsUserId>
   </urn:auth>
   <urn:allowEmptyValues>false</urn:allowEmptyValues>
   <urn:group>
      <urn:id>
         <urn:displayName>CR Submitters</urn:displayName>
      </urn:id>
      <urn:accessType>ACCESS-ADMIN</urn:accessType>
      <urn:memo></urn:memo>
      <urn:isDeleted>true</urn:isDeleted>
   </urn:group>
   <urn:options>
      <urn:multiOption>CONTINUE-ON-FAILURE</urn:multiOption>
   </urn:options>
</urn:UpdateGroups>