Web Services Developer's Guide → Web Services API Reference → SBM Administrative Web Services → Arguments → GroupListAction
The GroupListAction enumeration enables you to specify whether groups should be added, replaced, or removed during the UpdateUsers call.
Name | Type | Description |
---|---|---|
ADD-GROUPS | string | Adds the specified groups on update. |
REPLACE-GROUPS | string | Replaces the existing groups on update. |
REMOVE-GROUPS | string | Removes the specified groups on update. |
The GroupListAction element enables you to control how user groups are processed during the UpdateUsers call. Using the groupAction argument, you set one to these options to add, replace, or remove existing groups. See UpdateUsers for additional information.
The following XML shows GroupListAction in the <urn:groupAction> element of the UpdateUsers call. In this example, Joe is added to the CR Submitters group:
<urn:UpdateUsers> <urn:auth> <urn:userId></urn:userId> <urn:password></urn:password> <urn:hostname></urn:hostname> <urn:loginAsUserId></urn:loginAsUserId> </urn:auth> <urn:allowEmptyValues>false</urn:allowEmptyValues> <urn:groupAction>ADD-GROUPS</urn:groupAction> <urn:user> <urn:id> <urn:displayName>Joe</urn:displayName> <urn:id></urn:id> <urn:uuid></urn:uuid> <urn:loginId>Joe</urn:loginId> </urn:id> <urn:contact> <urn:displayName></urn:displayName> <urn:id></urn:id> <urn:uuid></urn:uuid> </urn:contact> <urn:group> <urn:displayName>CR Submitters</urn:displayName> <urn:id></urn:id> <urn:uuid></urn:uuid> </urn:group> </urn:user> </urn:UpdateUsers>
In this example, the current group membership for Nancy and Carmen is replaced. Nancy and Carmen now only belong to CR Submitters:
<urn:UpdateUsers> <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:groupAction>REPLACE-GROUPS</urn:groupAction> <urn:user> <urn:id> <urn:loginId>Nancy</urn:loginId> </urn:id> <urn:contact> <urn:displayName></urn:displayName> </urn:contact> <urn:group> <urn:displayName>CR Submitters</urn:displayName> </urn:group> </urn:user> <urn:user> <urn:id> <urn:loginId>Carmen</urn:loginId> </urn:id> <urn:contact> <urn:displayName></urn:displayName> <urn:id></urn:id> <urn:uuid></urn:uuid> </urn:contact> <urn:group> <urn:displayName>CR Submitters</urn:displayName> </urn:group> </urn:user> </urn:UpdateUsers>
Copyright © 2007–2015 Serena Software, Inc. All rights reserved.