Overview
Returns 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 |
| loginName | String |
| Mandatory |
| environment | String |
| Mandatory |
| environmentParamIsShortName | boolean |
| Mandatory |
Response
Parameters of the API response:
| Parameter | Type | Description |
|---|
| status | Status | Possible return values: - OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
- ERROR_ALREADY_EXISTS
|
| user | User |
|
Examples
Example GetUserByLoginNameAndEnvironment transaction.
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:getUserByLoginNameAndEnvironment>
<token>WnGS6R24I0e7An7YIHWWvC1LRA0avFzA</token>
<loginName>verbatest</loginName>
<environment>0000</environment>
<environmentParamIsShortName>0</environmentParamIsShortName>
</v3:getUserByLoginNameAndEnvironment>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getUserByLoginNameAndEnvironmentResponse 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>verbatest@verbalabs.com</email>
<environmentShortName>Ref.</environmentShortName>
<extensions>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<extension>+12444</extension>
<id>58</id>
<im>true</im>
<recordingMode>FULL</recordingMode>
<screenCaptureEnabled>false</screenCaptureEnabled>
<video>false</video>
<voice>true</voice>
</extensions>
<extensions>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<extension>12444</extension>
<id>59</id>
<im>true</im>
<recordingMode>FULL</recordingMode>
<screenCaptureEnabled>false</screenCaptureEnabled>
<video>false</video>
<voice>true</voice>
</extensions>
<extensions>
<eid>0000</eid>
<environmentShortName>Ref.</environmentShortName>
<extension>verbatest@verbalabs.com</extension>
<id>60</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>Developers</name>
<nonModifiable>false</nonModifiable>
</group>
<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>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-20T16:23:33.887Z</validFromUnmodifiable>
<validUntilUnmodifiable>2099-12-31T00:00:00Z</validUntilUnmodifiable>
</groupMemberships>
<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>
<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:getUserByLoginNameAndEnvironmentResponse>
</S:Body>
</S:Envelope>
