WebValidate
Initial Build |
2006.02 |
xWEB |
Web Method |
Response Type |
string |
Provides the customer key (cst_key) for the authenticated token that is passed as a parameter - this method can be invoked after a successful WebLogin method returns an authentication token. The authentication token is the only parameter for this method.
Please note that the "token" discussed in this method is different from the token described in the Authenticate web method.
Parameters
authenticationToken as string
Response
string
Sample Request
Note: Invoke the WebLogin method to query NetForum for an individual's login information - xWeb returns a token for this individual - the returned token is used in the WebValidate method.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Header>
<m:AuthorizationToken xmlns:m="http://www.avectra.com/2005/">
<m:Token>61989ead-fed9-4136-a05d-a2992e468306</m:Token>
</m:AuthorizationToken>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<m:WebLogin xmlns:m="http://www.avectra.com/2005/">
<m:userLoginPlain>mjemio@avectra.com</m:userLoginPlain>
<m:passwordPlain>password</m:passwordPlain>
<m:keyOverride></m:keyOverride>
</m:WebLogin>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>5483e51f-4736-4e44-b9b2-726b45cd7d9c</Token>
</AuthorizationToken>
<wsa:Action>http://www.avectra.com/2005/WebLoginResponse</wsa:Action>
<wsa:MessageID>uuid:7cba122c-92b1-470f-9d97-4e5046ba13a8</wsa:MessageID>
<wsa:RelatesTo>uuid:da39aec0-68dc-40e4-95b5-6d4055b3a302</wsa:RelatesTo>
<wsa:To>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:To>
<wsse:Security>
<wsu:Timestamp wsu:Id="Timestamp-6e7741ba-8efe-4e60-a79c-f3b493696536">
<wsu:Created>2006-09-26T13:54:59Z</wsu:Created>
<wsu:Expires>2006-09-26T13:59:59Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soap:Header>
<soap:Body>
<WebLoginResponse xmlns="http://www.avectra.com/2005/">
<WebLoginResult>a2364d6f-b2a7-4ce0-8cbd-50e0cb19d51c</WebLoginResult>
</WebLoginResponse>
</soap:Body>
</soap:Envelope>
Additional Scenario
Note: By passing the returned token from WebLogin method, the requesting party can have xWeb return the cst_key for this individual.
Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Header>
<m:AuthorizationToken xmlns:m="http://www.avectra.com/2005/">
<m:Token>5483e51f-4736-4e44-b9b2-726b45cd7d9c</m:Token>
</m:AuthorizationToken>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<m:WebValidate xmlns:m="http://www.avectra.com/2005/">
<m:authenticationToken>a2364d6f-b2a7-4ce0-8cbd-50e0cb19d51c</m:authenticationToken>
</m:WebValidate>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>0bf1fb4a-1f09-4fc4-ab57-e553bcc69fb9</Token>
</AuthorizationToken>
<wsa:Action>http://www.avectra.com/2005/WebValidateResponse</wsa:Action>
<wsa:MessageID>uuid:2c98031f-34b1-4710-86c1-6849c4a3a421</wsa:MessageID>
<wsa:RelatesTo>uuid:77288478-2c8d-4f0d-b934-20e22d111d45</wsa:RelatesTo>
<wsa:To>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:To>
<wsse:Security>
<wsu:Timestamp wsu:Id="Timestamp-91624a36-96bd-4e3a-881d-7acc2206ce6c">
<wsu:Created>2006-09-26T13:55:25Z</wsu:Created>
<wsu:Expires>2006-09-26T14:00:25Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soap:Header>
<soap:Body>
<WebValidateResponse xmlns="http://www.avectra.com/2005/">
<WebValidateResult>5bb1722f-dc51-4424-aee9-3b204fcf09b6</WebValidateResult>
</WebValidateResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/WebValidate
DATA: JSON
{
"WebValidate": {
"authenticationToken": "{{authenticationTokenWebValidate}}"
}
}
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
a031885c-cf37-4a7f-ab87-f6cde1dc6490