UpdateGroup (v2)
May 25, 2022
Overview
Updates a group.
The function is available as a Web Service request.
Request
Parameters of the API request:
Parameter | Type | Description | Requirements |
|---|
Parameter | Type | Description | Requirements |
|---|---|---|---|
token | String | API authentication token | Mandatory |
group | Specifies the updated group | Mandatory | |
updateUsers | boolean | Specifies whether to update the users section of the group or not | Mandatory |
Response
Parameters of the API response:
Examples
Example UpdateGroup transaction without user update.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:updateGroup>
<token>fp9chQ4hA7vsa3Wymx8gxMf3vLo2Tu6G</token>
<group>
<eid>0000</eid>
<!-- <environmentShortName></environmentShortName> -->
<id>2</id>
<name>New Group Name</name>
<nonModifiable>0</nonModifiable>
</group>
<updateUsers>0</updateUsers>
</v2:updateGroup>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateGroupResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
<return>
<group>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<id>2</id>
<name>New Group Name</name>
<nonModifiable>false</nonModifiable>
<users>
<admin>false</admin>
<member>true</member>
<primary>false</primary>
<supervisor>true</supervisor>
<uniqueIdUnmodifiable>31</uniqueIdUnmodifiable>
<user>
<apiAccessOnly>false</apiAccessOnly>
<displayName>Balázs Oláh</displayName>
<eid>0000</eid>
<email>olahi@verba.com</email>
<environmentShortName>Ref.</environmentShortName>
<id>14</id>
<language>en</language>
<locked>false</locked>
<loginName>balazs</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<passwordExpires>false</passwordExpires>
<passwordHash>................................</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-11-19T14:35:26.310Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-19T14:53:03.733Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
<users>
<admin>true</admin>
<member>true</member>
<primary>false</primary>
<supervisor>true</supervisor>
<uniqueIdUnmodifiable>30</uniqueIdUnmodifiable>
<user>
<apiAccessOnly>false</apiAccessOnly>
<displayName>Kakas Norbert</displayName>
<eid>0000</eid>
<email>kakas@verba.com</email>
<environmentShortName>Ref.</environmentShortName>
<id>24</id>
<language>en</language>
<locked>false</locked>
<loginName>norbi</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<passwordExpires>false</passwordExpires>
<passwordHash>....................</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-11-19T14:35:26.310Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-19T14:53:03.687Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
<users>
<admin>true</admin>
<member>true</member>
<primary>true</primary>
<supervisor>true</supervisor>
<uniqueIdUnmodifiable>39</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<customDateFormat/>
<customTimeFormat/>
<displayName>Verba Test User</displayName>
<eid>0000</eid>
<email>verbatest@verbalabs.com</email>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>36</id>
<language>en</language>
<locked>false</locked>
<loginName>verbatest</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<observerGroupId>0</observerGroupId>
<observerUserId>0</observerUserId>
<passwordExpires>false</passwordExpires>
<passwordHash>...............</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-09-03T11:56:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-20T16:23:33.887Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
</group>
<status>
<statusCode>OK</statusCode>
</status>
</return>
</ns2:updateGroupResponse>
</S:Body>
</S:Envelope>
Example UpdateGroup transaction. Delete all users except the one with id 36.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:updateGroup>
<token>s9GtyBR8vN3JXuwQoMsRtviEiX5zi0Wn</token>
<group>
<eid>0000</eid>
<!-- <environmentShortName></environmentShortName> -->
<id>2</id>
<!-- <name>New group name</name> -->
<nonModifiable>0</nonModifiable>
<!--Zero or more repetitions:-->
<users>
<admin>1</admin>
<member>1</member>
<primary>1</primary>
<supervisor>0</supervisor>
<uniqueIdUnmodifiable>0</uniqueIdUnmodifiable>
<validFromUnmodifiable>0</validFromUnmodifiable>
<validUntilUnmodifiable>0</validUntilUnmodifiable>
<user>
<id>36</id>
</user>
</users>
</group>
<updateUsers>1</updateUsers> <!-- Set to TRUE! -->
</v2:updateGroup>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateGroupResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
<return>
<group>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<id>2</id>
<name>New group name</name>
<nonModifiable>false</nonModifiable>
<users>
<admin>true</admin>
<member>true</member>
<primary>true</primary>
<supervisor>false</supervisor>
<uniqueIdUnmodifiable>51</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<customDateFormat/>
<customTimeFormat/>
<displayName>Verba Test User</displayName>
<eid>0000</eid>
<email>verbatest@verbalabs.com</email>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>36</id>
<language>en</language>
<locked>false</locked>
<loginName>verbatest</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<observerGroupId>0</observerGroupId>
<observerUserId>0</observerUserId>
<passwordExpires>false</passwordExpires>
<passwordHash>673as22ecba23ca</passwordHash>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-09-03T11:56:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
<validFromUnmodifiable>2015-11-26T16:34:51.037Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</users>
</group>
<status>
<statusCode>OK</statusCode>
</status>
</return>
</ns2:updateGroupResponse>
</S:Body>
</S:Envelope>