Modify Group webservice SOAP UI Example

Products

• CA Identity Manager
• CA Identity Suite

Issue/Introduction

Please provide a sample SOAP request to add a user into an Identity Manager group via TEWS and to remove a user from a group.

Environment

Release : Any

Component : IdentityMinder(Identity Manager)

Resolution

Following is a sample request showing the Modify Group task which will add one user to the group:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://tews6/wsdl">
   <soapenv:Header/>
   <soapenv:Body>
      <wsdl:TaskContext>
         <wsdl:admin_id>imadmin</wsdl:admin_id>
         <wsdl:admin_password>password</wsdl:admin_password>
      </wsdl:TaskContext>
      <wsdl:ModifyGroup>
         <wsdl:ModifyGroupSearch>
            <wsdl:Subject index="0">
               <wsdl:FriendlyName>TestGroup00</wsdl:FriendlyName>
            </wsdl:Subject>
         </wsdl:ModifyGroupSearch>
         <wsdl:ModifyGroupMembershipTab>
            <wsdl:GroupMembers>
               <wsdl:add index="0">
                  <wsdl:UID>test0001</wsdl:UID>
               </wsdl:add>
            </wsdl:GroupMembers>
         </wsdl:ModifyGroupMembershipTab>
      </wsdl:ModifyGroup>
   </soapenv:Body>
</soapenv:Envelope>

 

Following is a sample request showing the Modify Group task which will remove one user from the group:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://tews6/wsdl">
   <soapenv:Header/>
   <soapenv:Body>
      <wsdl:TaskContext>
         <wsdl:admin_id>imadmin</wsdl:admin_id>
         <wsdl:admin_password>password</wsdl:admin_password>
      </wsdl:TaskContext>
      <wsdl:ModifyGroup>
         <wsdl:ModifyGroupSearch>
            <wsdl:Subject index="0">
               <wsdl:FriendlyName>TestGroup00</wsdl:FriendlyName>
            </wsdl:Subject>
         </wsdl:ModifyGroupSearch>
         <wsdl:ModifyGroupMembershipTab>
            <wsdl:GroupMembers>
               <wsdl:remove index="0">
                  <wsdl:UID>test0001</wsdl:UID>
               </wsdl:remove>
            </wsdl:GroupMembers>
         </wsdl:ModifyGroupMembershipTab>
      </wsdl:ModifyGroup>
   </soapenv:Body>
</soapenv:Envelope>

Additional Information

There is also the new Group Membership Filter tab that can optionally be configured:

https://techdocs.broadcom.com/us/en/symantec-security-software/identity-security/identity-manager/14-4/administrating/administrators-users-and-groups/groups/Using-Custom-Group-Membership-Tabs.html

 

Following is a sample request showing the use of the ModifyGroupGroupMembershipFilterTab which can be added to the Modify Group task which will add one user to the group:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://tews6/wsdl">
   <soapenv:Header/>
   <soapenv:Body>
      <wsdl:TaskContext>
         <wsdl:admin_id>imadmin</wsdl:admin_id>
         <wsdl:admin_password>password</wsdl:admin_password>
      </wsdl:TaskContext>
      <wsdl:ModifyGroup>
         <wsdl:ModifyGroupSearch>
            <wsdl:Subject index="?">
               <wsdl:FriendlyName>TestGroup00</wsdl:FriendlyName>
            </wsdl:Subject>
         </wsdl:ModifyGroupSearch>
    <wsdl:ModifyGroupGroupMembershipFilterTab>
            <wsdl:GroupMembers>
               <wsdl:add index="?">
                  <wsdl:Name>test0001</wsdl:Name>
               </wsdl:add>
            </wsdl:GroupMembers>
         </wsdl:ModifyGroupGroupMembershipFilterTab>
      </wsdl:ModifyGroup>
   </soapenv:Body>
</soapenv:Envelope>
   </soapenv:Body>
</soapenv:Envelope>

 

But be aware that the request showing the use of the ModifyGroupGroupMembershipFilterTab which can be added to the Modify Group task which will remove one user from the group does not work and peforms no update:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://tews6/wsdl">
   <soapenv:Header/>
   <soapenv:Body>
      <wsdl:TaskContext>
         <wsdl:admin_id>imadmin</wsdl:admin_id>
         <wsdl:admin_password>password</wsdl:admin_password>
      </wsdl:TaskContext>
      <wsdl:ModifyGroup>
         <wsdl:ModifyGroupSearch>
            <wsdl:Subject index="?">
               <wsdl:FriendlyName>TestGroup00</wsdl:FriendlyName>
            </wsdl:Subject>
         </wsdl:ModifyGroupSearch>
    <wsdl:ModifyGroupGroupMembershipFilterTab>
            <wsdl:GroupMembers>
               <wsdl:remove index="?">
                  <wsdl:Name>test0001</wsdl:Name>
               </wsdl:remove>
            </wsdl:GroupMembers>
         </wsdl:ModifyGroupGroupMembershipFilterTab>
      </wsdl:ModifyGroup>
   </soapenv:Body>
</soapenv:Envelope>