UpdateUser (v3)
Kiss, Mate
Owned by Kiss, Mate
Feb 26, 2024
15 min read
Loading data...
Overview
Updates a user.The function is available as a Web Service request.
Request
Parameters of the API request:
| Parameter | Type | Description | Requirements |
|---|---|---|---|
| token | String | API authentication token | Mandatory |
| user | User | Specifies the updated group | Mandatory |
| updateGroupMembership | boolean | Specifies if the update contains group membership changes too. | Optional |
Response
Parameters of the API response:
| Parameter | Type | Description |
|---|---|---|
| return | Status | Possible return values:
|
| user | User |
Examples
 Example UpdateUser transaction with adding the user to a second group.
Example UpdateUser transaction with adding the user to a second group.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v3:updateUser>
<token>2Q14vHt8txwHZZeVGuZuMVuP6Czgq0cX</token>
<updateGroupMembership>1</updateGroupMembership>
<user>
<agentId></agentId>
<externalId></externalId>
<crmUserId></crmUserId>
<customDateFormat></customDateFormat>
<customTimeFormat></customTimeFormat>
<loginName>verbatestUpdate</loginName>
<needChangePassword>0</needChangePassword>
<displayName>Verba Test User</displayName>
<email>verbatestUpdate@verbalabs.com</email>
<userType>user_type_verba</userType> <!-- Standard user type -->
<eid>0000</eid>
<!-- Needed if eid is not present
<environmentShortName></environmentShortName>
-->
<!--Zero or more repetitions:-->
<extensions>
<eid>0000</eid>
<!-- Needed if eid is not present
<environmentShortName></environmentShortName>
-->
<extension>+12444</extension>
<recordingMode>FULL</recordingMode>
<im>1</im>
<voice>1</voice>
<video>0</video>
<screenCaptureEnabled>0</screenCaptureEnabled>
</extensions>
<extensions>
<eid>0000</eid>
<!-- Needed if eid is not present
<environmentShortName></environmentShortName>
-->
<extension>12444</extension>
<recordingMode>FULL</recordingMode>
<im>1</im>
<voice>1</voice>
<video>0</video>
<screenCaptureEnabled>0</screenCaptureEnabled>
</extensions>
<extensions>
<eid>0000</eid>
<!-- Needed if eid is not present
<environmentShortName></environmentShortName>
-->
<extension>verbatestUpdate@verbalabs.com</extension>
<recordingMode>FULL</recordingMode>
<im>1</im>
<voice>1</voice>
<video>0</video>
<screenCaptureEnabled>0</screenCaptureEnabled>
</extensions>
<!--Zero or more repetitions:-->
<groupMemberships>
<member>1</member>
<primary>1</primary>
<supervisor>1</supervisor>
<admin>1</admin>
<group>
<eid>0000</eid>
<!-- <environmentShortName>?</environmentShortName>-->
<id>2</id>
</group>
<uniqueIdUnmodifiable>0</uniqueIdUnmodifiable>
<validFromUnmodifiable>0</validFromUnmodifiable>
<validUntilUnmodifiable>0</validUntilUnmodifiable>
</groupMemberships>
<groupMemberships>
<member>1</member>
<primary>0</primary>
<supervisor>0</supervisor>
<admin>0</admin>
<group>
<eid>0000</eid>
<!-- <environmentShortName>?</environmentShortName>-->
<id>3</id>
</group>
<uniqueIdUnmodifiable>0</uniqueIdUnmodifiable>
<validFromUnmodifiable>0</validFromUnmodifiable>
<validUntilUnmodifiable>0</validUntilUnmodifiable>
</groupMemberships>
<language>en</language>
<timeZone>Europe/Budapest</timeZone>
<locked>0</locked>
<nonModifiable>0</nonModifiable>
<observerGroupId></observerGroupId>
<observerUserId></observerUserId>
<passwordExpires>0</passwordExpires>
<passwordHash>MD5HASH("your-password")</passwordHash>
<!-- <recorderLinePIN></recorderLinePIN> -->
<apiAccessOnly>0</apiAccessOnly>
<validFrom>2015-09-03T11:56:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
<!--Zero or more repetitions:-->
<roles>r_standard_user</roles>
<roles>r_system_supervisor</roles>
<roles>r_system_administrator</roles>
</user>
</v3:updateUser>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateUserResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
<return>
<status>
<statusCode>OK</statusCode>
</status>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<customDateFormat/>
<customTimeFormat/>
<displayName>Verba Test User</displayName>
<eid>0000</eid>
<email>verbatestUpdate@verbalabs.com</email>
<environmentShortName>Ref.</environmentShortName>
<extensions>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<extension>verbatestUpdate@verbalabs.com</extension>
<id>61</id>
<im>true</im>
<recordingMode>FULL</recordingMode>
<screenCaptureEnabled>false</screenCaptureEnabled>
<video>false</video>
<voice>true</voice>
</extensions>
<externalId/>
<groupMemberships>
<admin>true</admin>
<group>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<id>2</id>
<name>New group name</name>
<nonModifiable>false</nonModifiable>
</group>
<member>true</member>
<primary>true</primary>
<supervisor>true</supervisor>
<uniqueIdUnmodifiable>56</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<customDateFormat/>
<customTimeFormat/>
<displayName>Verba Test User</displayName>
<eid>0000</eid>
<email>verbatestUpdate@verbalabs.com</email>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>40</id>
<language>en</language>
<locked>false</locked>
<loginName>verbatestUpdate</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-30T01:26:50.460Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</groupMemberships>
<groupMemberships>
<admin>false</admin>
<group>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<id>3</id>
<name>Other group name</name>
<nonModifiable>false</nonModifiable>
</group>
<member>true</member>
<primary>false</primary>
<supervisor>false</supervisor>
<uniqueIdUnmodifiable>57</uniqueIdUnmodifiable>
<user>
<agentId/>
<apiAccessOnly>false</apiAccessOnly>
<customDateFormat/>
<customTimeFormat/>
<displayName>Verba Test User</displayName>
<eid>0000</eid>
<email>verbatestUpdate@verbalabs.com</email>
<environmentShortName>Ref.</environmentShortName>
<externalId/>
<id>40</id>
<language>en</language>
<locked>false</locked>
<loginName>verbatestUpdate</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-30T01:26:50.460Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</groupMemberships>
<id>40</id>
<language>en</language>
<locked>false</locked>
<loginName>verbatestUpdate</loginName>
<needChangePassword>false</needChangePassword>
<nonModifiable>false</nonModifiable>
<observerGroupId>0</observerGroupId>
<observerUserId>0</observerUserId>
<passwordExpires>false</passwordExpires>
<roles>r_standard_user</roles>
<roles>r_system_administrator</roles>
<roles>r_system_supervisor</roles>
<timeZone>Europe/Budapest</timeZone>
<userType>user_type_verba</userType>
<validFrom>2015-09-03T11:56:00Z</validFrom>
<validTo>2099-12-31T00:00:00Z</validTo>
</user>
</return>
</ns2:updateUserResponse>
</S:Body>
</S:Envelope>