This operation validates a user. For example, before allowing a user to perform a sensitive operation, prompt the user for his or her password.
Request
Syntax
POST <webservice>/User/Validate HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml <validate_user_template.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The media type contained in the request body. |
Request Body
Download the validate_user_template.xml file required for this request. The following table displays the parameters for the request body.
|
Parameter |
Description |
Element |
|---|---|---|
|
password |
The plain text password that belongs to the user you are validating. |
App_ValidateDataSecurityRequest |
|
userName |
The name of the user. You can use the userName parameter or the userId parameter. |
user |
|
userId |
The system-generated ID assigned to the user. You can use the userName parameter or the userId parameter. |
user |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
errorCode |
The possible error codes. Valid values are:
|
response |
Examples
Sample Request
POST <webservice>/User/Validate HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<App_ValidateDataSecurityRequest password="Password123"> <user userId="1"/>
</App_ValidateDataSecurityRequest>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericEntityResponse errorCode="0"/>