POST api/Mail/Verify?user={user}
Verify a user password
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| user |
user handle |
string |
None. |
Body Parameters
Object with user and password to check
PwdCheck| Name | Description | Type | Additional information |
|---|---|---|---|
| ObjectHandle |
Object handle of the mail box |
string |
None. |
| UserMailAddress | string |
None. |
|
| Password | string |
None. |
|
| PasswordValid | boolean |
None. |
|
| Errors |
List of errors encountered |
Collection of Error |
None. |
Request Formats
application/json, text/json
Sample:
{
"ObjectHandle": "sample string 1",
"UserMailAddress": "sample string 2",
"Password": "sample string 3",
"PasswordValid": true,
"Errors": []
}
application/xml, text/xml
Sample:
<PwdCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models"> <Errors /> <ObjectHandle>sample string 1</ObjectHandle> <Password>sample string 3</Password> <PasswordValid>true</PasswordValid> <UserMailAddress>sample string 2</UserMailAddress> </PwdCheck>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
a password check object on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error
550 - parameter value policy error
| Name | Description | Type | Additional information |
|---|---|---|---|
| ObjectHandle |
Object handle of the mail box |
string |
None. |
| UserMailAddress | string |
None. |
|
| Password | string |
None. |
|
| PasswordValid | boolean |
None. |
|
| Errors |
List of errors encountered |
Collection of Error |
None. |
Response Formats
application/json, text/json
Sample:
{
"ObjectHandle": "sample string 1",
"UserMailAddress": "sample string 2",
"Password": "sample string 3",
"PasswordValid": true,
"Errors": []
}
application/xml, text/xml
Sample:
<PwdCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models"> <Errors /> <ObjectHandle>sample string 1</ObjectHandle> <Password>sample string 3</Password> <PasswordValid>true</PasswordValid> <UserMailAddress>sample string 2</UserMailAddress> </PwdCheck>