Companywebcast API Wiki
Navigation
Cwc API Home
PlayerSDK
Meta Service
Getting Started
Creating a client
Methods
Data Types
Understanding Webcast security
Management Service
Getting Started
Creating a client
Methods
Data Types
Quick Search
Advanced Search »
Back
History
Sso Service
<style type="text/css"> div.header table { position: relative; left: 0px; top: 0px; padding: 0px 0px 0px 0px; margin: 0px 0px 0px 0px; width: 100%; height: 21px; border-collapse: collapse; border-style: solid; border-width: 0px; background-color: #99ccff; } div.header table td { margin: 0px 0px 0px 0px; padding: 2px 0px 0px 4px; vertical-align: middle; border-width: 0px; border-style: solid; border-color: #999999; background: transparent; } table { width: 90%; margin-top: .6em; margin-bottom: .3em; border-width: 1px 1px 0px 1px; border-style: solid; border-color: #999999; color:Black; background-color: #999999; } table th { background: #cccccc; vertical-align: bottom; font-family: Arial, Helvetica, sans-serif; font-style: normal; font-weight: bold; font-size: 10pt; color: Black; } table td { padding-left: 12px; background: #ffffff; vertical-align: top; font-family: Arial, Helvetica, sans-serif; font-style: normal; font-weight: normal; font-size: 10pt; color: Black; } table th, table td { border-style: solid; border-width: 0px 0px 1px 0px; border-color: #999999; padding: 4px 6px; text-align: left; } tr.startGroup0 td.first { background-color: #99ccff; padding-top: 2px; padding-bottom: 0px; background-image: url(ReportService_files/TopTab.gif); background-repeat: no-repeat; padding-left: 10; background-position: -80px 0; } tr.endGroup0 td.first { background-color: #99ccff; height: 10px; background-image: url(ReportService_files/BottomTab.gif); background-repeat: no-repeat; padding-left: 10; background-position: -80px 0; } tr.group0 td.first { padding-left: 10; } tr.startGroup0 td.middle, tr.startGroup0 td.last, tr.endGroup0 td.middle, tr.endGroup0 td.last { background-color: #99ccff; } tr.startGroup1 td.first { background-color: #80FF80; padding-top: 2px; padding-bottom: 0px; background-image: url(ReportService_files/TopTab.gif); background-repeat: no-repeat; padding-left: 20; background-position: -70px 0; } tr.endGroup1 td.first { background-color: #80FF80; height: 10px; background-image: url(ReportService_files/BottomTab.gif); background-repeat: no-repeat; padding-left: 20; background-position: -70px 0; } tr.group1 td.first { padding-left: 20; } tr.startGroup1 td.middle, tr.startGroup1 td.last, tr.endGroup1 td.middle, tr.endGroup1 td.last { background-color: #80FF80; } tr.startGroup2 td.first { background-color: #FFFF80; padding-top: 2px; padding-bottom: 0px; background-image: url(ReportService_files/TopTab.gif); background-repeat: no-repeat; padding-left: 30; background-position: -60px 0; } tr.endGroup2 td.first { background-color: #FFFF80; height: 10px; background-image: url(ReportService_files/BottomTab.gif); background-repeat: no-repeat; padding-left: 30; background-position: -60px 0; } tr.group2 td.first { padding-left: 30; } tr.startGroup2 td.middle, tr.startGroup2 td.last, tr.endGroup2 td.middle, tr.endGroup2 td.last { background-color: #FFFF80; } tr.startGroup3 td.first { background-color: #8080FF; padding-top: 2px; padding-bottom: 0px; background-image: url(ReportService_files/TopTab.gif); background-repeat: no-repeat; padding-left: 40; background-position: -50px 0; } tr.endGroup3 td.first { background-color: #8080FF; height: 10px; background-image: url(ReportService_files/BottomTab.gif); background-repeat: no-repeat; padding-left: 40; background-position: -50px 0; } tr.group3 td.first { padding-left: 40; } tr.startGroup3 td.middle, tr.startGroup3 td.last, tr.endGroup3 td.middle, tr.endGroup3 td.last { background-color: #8080FF; } tr.startGroup4 td.first { background-color: #FF80FF; padding-top: 2px; padding-bottom: 0px; background-image: url(ReportService_files/TopTab.gif); background-repeat: no-repeat; padding-left: 50; background-position: -40px 0; } tr.endGroup4 td.first { background-color: #FF80FF; height: 10px; background-image: url(ReportService_files/BottomTab.gif); background-repeat: no-repeat; padding-left: 50; background-position: -40px 0; } tr.group4 td.first { padding-left: 50; } tr.startGroup4 td.middle, tr.startGroup4 td.last, tr.endGroup4 td.middle, tr.endGroup4 td.last { background-color: #FF80FF; } </style> </div><a name="WS-SsoService"></a><div class="title"> <h3>SsoService Web Service</h3> <h3><a href="http://services.companywebcast.com/sso/1.0/SsoService.svc?wsdl">http://services.companywebcast.com/sso/1.0/SsoService.svc?wsdl</a></h3> </div> <div class="body"> <h3>Description</h3> <p>This service provides a means to encrypt, decrypt and validate tokens </p> <h5>See Also</h5> <p><a href="#ME-SsoService">Methods</a> | <a href="#CT-SsoService">Complex Types</a></p> </div><a name="ME-SsoService"></a><div class="title"> <h4>Methods: SsoService</h4> </div> <div class="body"> <h5>Methods</h5> <table cellspacing="0" class="reference"> <col width="35%"> <col width="65%"> <thead> <tr> <th>Name </th> <th>Description </th> </tr> </thead> <tbody> <tr> <td><a href="#ME-SsoService-AssembleUserToken">AssembleUserToken</a> </td> <td style="text-align: ">Assembles a user token <br></td> </tr> <tr> <td><a href="#ME-SsoService-AssembleVisitorToken">AssembleVisitorToken</a> </td> <td style="text-align: ">Assembles a visitor token <br></td> </tr> <tr> <td><a href="#ME-SsoService-DisassembleToken">DisassembleToken</a> </td> <td style="text-align: ">Decrypts an encrypted token <br></td> </tr> <tr> <td><a href="#ME-SsoService-ValidateToken">ValidateToken</a> </td> <td style="text-align: ">Checks if a token is valid for a specific webcast <br></td> </tr> </tbody> </table> </div><a name="ME-SsoService-AssembleUserToken"></a><div class="title"> <h5>Method: AssembleUserToken</h5> </div> <div class="body"> <h5>Description</h5> <p>Assembles a user token </p> <h5>Parameters</h5> <table cellspacing="0" class="reference"> <col width="20%"> <col width="20%"> <col width="15%"> <col width="45%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Direction </th> <th>Description </th> </tr> </thead> <tbody> <tr> <td>AssembleUserTokenIn </td> <td><a href="#CT-SsoService-tns_AssembleUserTokenIn">AssembleUserTokenIn</a> </td> <td>Input </td> <td style="text-align: ">Contains required information to build a user token<br></td> </tr> </tbody> </table> <h5>Returns</h5> <p>A AssembleUserTokenResult element having the structure defined by the following table.</p> <table cellspacing="0" class="grouped"> <col width="25%"> <col width="25%"> <col width="50%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Description </th> </tr> </thead> <tbody> <tr class="group-1"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group-1"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="group-1"> <td class="first">Token </td> <td class="middle">string </td> <td style="text-align: " class="last">A security token <br></td> </tr> </tbody> </table> </div><a name="ME-SsoService-AssembleVisitorToken"></a><div class="title"> <h5>Method: AssembleVisitorToken</h5> </div> <div class="body"> <h5>Description</h5> <p>Assembles a visitor token </p> <h5>Parameters</h5> <table cellspacing="0" class="reference"> <col width="20%"> <col width="20%"> <col width="15%"> <col width="45%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Direction </th> <th>Description </th> </tr> </thead> <tbody> <tr> <td>AssembleVisitorTokenIn </td> <td><a href="#CT-SsoService-tns_AssembleVisitorTokenIn">AssembleVisitorTokenIn</a> </td> <td>Input </td> <td style="text-align: ">Contains required information to build a visitor token<br></td> </tr> </tbody> </table> <h5>Returns</h5> <p>A AssembleVisitorTokenResult element having the structure defined by the following table.</p> <table cellspacing="0" class="grouped"> <col width="25%"> <col width="25%"> <col width="50%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Description </th> </tr> </thead> <tbody> <tr class="group-1"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group-1"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="group-1"> <td class="first">Token </td> <td class="middle">string </td> <td style="text-align: " class="last">A security token <br></td> </tr> </tbody> </table> </div><a name="ME-SsoService-DisassembleToken"></a><div class="title"> <h5>Method: DisassembleToken</h5> </div> <div class="body"> <h5>Description</h5> <p>Decrypts an encrypted token </p> <h5>Parameters</h5> <table cellspacing="0" class="reference"> <col width="20%"> <col width="20%"> <col width="15%"> <col width="45%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Direction </th> <th>Description </th> </tr> </thead> <tbody> <tr> <td>DisassembleTokenIn </td> <td><a href="#CT-SsoService-tns_DisassembleTokenIn">DisassembleTokenIn</a> </td> <td>Input </td> <td style="text-align: ">Contains the token to be decrypted<br></td> </tr> </tbody> </table> <h5>Returns</h5> <p>A DisassembleTokenResult element having the structure defined by the following table.</p> <table cellspacing="0" class="grouped"> <col width="25%"> <col width="25%"> <col width="50%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Description </th> </tr> </thead> <tbody> <tr class="group-1"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group-1"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="group-1"> <td class="first">SsoToken </td> <td class="middle"><a href="#CT-SsoService-tns_SsoToken">SsoToken</a> </td> <td style="text-align: " class="last">A dissasembled SsoToken<br></td> </tr> </tbody> </table> </div><a name="ME-SsoService-ValidateToken"></a><div class="title"> <h5>Method: ValidateToken</h5> </div> <div class="body"> <h5>Description</h5> <p>Checks if a token is valid for a specific webcast </p> <h5>Parameters</h5> <table cellspacing="0" class="reference"> <col width="20%"> <col width="20%"> <col width="15%"> <col width="45%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Direction </th> <th>Description </th> </tr> </thead> <tbody> <tr> <td>ValidateTokenIn </td> <td><a href="#CT-SsoService-tns_ValidateTokenIn">ValidateTokenIn</a> </td> <td>Input </td> <td style="text-align: ">Contains the token to be checked for validity<br></td> </tr> </tbody> </table> <h5>Returns</h5> <p>A ValidateTokenResult element having the structure defined by the following table.</p> <table cellspacing="0" class="grouped"> <col width="25%"> <col width="25%"> <col width="50%"> <thead> <tr> <th>Name </th> <th>Type </th> <th>Description </th> </tr> </thead> <tbody> <tr class="group-1"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group-1"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="group-1"> <td class="first">IsValid </td> <td class="middle">boolean </td> <td style="text-align: " class="last">True if valid <br></td> </tr> </tbody> </table> </div><a name="CT-SsoService"></a><div class="title"> <h4>Complex Types: SsoService</h4> </div> <div class="body"> <h5>Complex Types</h5> <table cellspacing="0" class="reference"> <col width="35%"> <col width="65%"> <thead> <tr> <th>Name </th> <th>Description </th> </tr> </thead> <tbody> <tr> <td><a href="#CT-SsoService-tns_AssembleTokenOut">AssembleTokenOut</a> </td> <td style="text-align: ">Helper class Contains an assembled token or an error <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_AssembleUserTokenIn">AssembleUserTokenIn</a> </td> <td style="text-align: ">Helper class Contains properties required to build a <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_AssembleVisitorTokenIn">AssembleVisitorTokenIn</a> </td> <td style="text-align: ">Helper class Contains properties required to build a visitor token <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_DisassembleTokenIn">DisassembleTokenIn</a> </td> <td style="text-align: ">Helper class Contains properties used to disassemble a token <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_DisassembleTokenOut">DisassembleTokenOut</a> </td> <td style="text-align: ">Helper class contains a disassembled token or an error <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td style="text-align: ">A collection of errors <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_RequestBase">RequestBase</a> </td> <td> </td> </tr> <tr> <td><a href="#CT-SsoService-tns_ResponseBase">ResponseBase</a> </td> <td> </td> </tr> <tr> <td><a href="#CT-SsoService-tns_SsoToken">SsoToken</a> </td> <td style="text-align: ">proxy token class Replaces <a href="#CT-SsoService-tns_SsoUserToken">SsoUserToken</a> or <a href="#CT-SsoService-tns_SsoVisitorToken">SsoVisitorToken</a><br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_SsoUserToken">SsoUserToken</a> </td> <td style="text-align: ">Token containing properties required to generate a user token <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_SsoVisitorToken">SsoVisitorToken</a> </td> <td style="text-align: ">Token containing properties required to generate a visitor token <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_ValidateTokenIn">ValidateTokenIn</a> </td> <td style="text-align: ">Helper class Contains properties that are required to validate a token <br></td> </tr> <tr> <td><a href="#CT-SsoService-tns_ValidateTokenOut">ValidateTokenOut</a> </td> <td style="text-align: ">Helper class Used to check if a token has been succesfully validated <br></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_AssembleTokenOut"></a><div class="title"> <h5>Complex Type: AssembleTokenOut</h5> </div> <div class="body"> <h5>Description</h5> <p>Helper class Contains an assembled token or an error </p> <h5>Derived By</h5> <p>Extending <a href="#CT-SsoService-tns_ResponseBase">ResponseBase</a></p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group0"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="group0"> <td class="first">Token </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">A security token <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_AssembleUserTokenIn"></a><div class="title"> <h5>Complex Type: AssembleUserTokenIn</h5> </div> <div class="body"> <h5>Description</h5> <p>Helper class Contains properties required to build a </p> <h5>Derived By</h5> <p>Extending <a href="#CT-SsoService-tns_RequestBase">RequestBase</a></p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Password </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">The user's password <br></td> </tr> <tr class="group0"> <td class="first">Username </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">The user's username <br></td> </tr> <tr class="group0"> <td class="first">SsoUserToken </td> <td class="middle"><a href="#CT-SsoService-tns_SsoUserToken">SsoUserToken</a> </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">A SsoUserToken<br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_AssembleVisitorTokenIn"></a><div class="title"> <h5>Complex Type: AssembleVisitorTokenIn</h5> </div> <div class="body"> <h5>Description</h5> <p>Helper class Contains properties required to build a visitor token </p> <h5>Derived By</h5> <p>Extending <a href="#CT-SsoService-tns_RequestBase">RequestBase</a></p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Password </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Password of the user who requests the token (not the visitor!) <br></td> </tr> <tr class="group0"> <td class="first">Username </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Username of the user who requests the token (not the visitor!) <br></td> </tr> <tr class="group0"> <td class="first">SsoVisitorToken </td> <td class="middle"><a href="#CT-SsoService-tns_SsoVisitorToken">SsoVisitorToken</a> </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">A SsoVisitorToken<br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_DisassembleTokenIn"></a><div class="title"> <h5>Complex Type: DisassembleTokenIn</h5> </div> <div class="body"> <h5>Description</h5> <p>Helper class Contains properties used to disassemble a token </p> <h5>Derived By</h5> <p>Extending <a href="#CT-SsoService-tns_RequestBase">RequestBase</a></p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Username </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">A username <br></td> </tr> <tr class="group0"> <td class="first">Password </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">A password <br></td> </tr> <tr class="group0"> <td class="first">Token </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">The token to be disassembled <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_DisassembleTokenOut"></a><div class="title"> <h5>Complex Type: DisassembleTokenOut</h5> </div> <div class="body"> <h5>Description</h5> <p>Helper class contains a disassembled token or an error </p> <h5>Derived By</h5> <p>Extending <a href="#CT-SsoService-tns_ResponseBase">ResponseBase</a></p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group0"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="group0"> <td class="first">SsoToken </td> <td class="middle"><a href="#CT-SsoService-tns_SsoToken">SsoToken</a> </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">A dissasembled SsoToken<br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_Errors"></a><div class="title"> <h5>Complex Type: Errors</h5> </div> <div class="body"> <h5>Description</h5> <p>A collection of errors </p> <h5>Derived By</h5> <p>Restricting anyType</p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">string </td> <td class="middle">string </td> <td class="middle">0..* </td> <td class="last"> </td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_RequestBase"></a><div class="title"> <h5>Complex Type: RequestBase</h5> </div> <div class="body"> <h5>Derived By</h5> <p>Restricting anyType</p> <h5>Referenced By</h5> <table cellspacing="0" class="reference"> <col width="50%"> <col width="50%"> <thead> <tr> <th>Name </th> <th>Type </th> </tr> </thead> <tbody> <tr> <td><a href="#CT-SsoService-tns_AssembleUserTokenIn">AssembleUserTokenIn</a> </td> <td>Complex Type </td> </tr> <tr> <td><a href="#CT-SsoService-tns_AssembleVisitorTokenIn">AssembleVisitorTokenIn</a> </td> <td>Complex Type </td> </tr> <tr> <td><a href="#CT-SsoService-tns_DisassembleTokenIn">DisassembleTokenIn</a> </td> <td>Complex Type </td> </tr> <tr> <td><a href="#CT-SsoService-tns_ValidateTokenIn">ValidateTokenIn</a> </td> <td>Complex Type </td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_ResponseBase"></a><div class="title"> <h5>Complex Type: ResponseBase</h5> </div> <div class="body"> <h5>Derived By</h5> <p>Restricting anyType</p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group0"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> <h5>Referenced By</h5> <table cellspacing="0" class="reference"> <col width="50%"> <col width="50%"> <thead> <tr> <th>Name </th> <th>Type </th> </tr> </thead> <tbody> <tr> <td><a href="#CT-SsoService-tns_AssembleTokenOut">AssembleTokenOut</a> </td> <td>Complex Type </td> </tr> <tr> <td><a href="#CT-SsoService-tns_DisassembleTokenOut">DisassembleTokenOut</a> </td> <td>Complex Type </td> </tr> <tr> <td><a href="#CT-SsoService-tns_ValidateTokenOut">ValidateTokenOut</a> </td> <td>Complex Type </td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_SsoToken"></a><div class="title"> <h5>Complex Type: SsoToken</h5> </div> <div class="body"> <h5>Description</h5> <p>proxy token class Replaces <a href="#CT-SsoService-tns_SsoUserToken">SsoUserToken</a> or <a href="#CT-SsoService-tns_SsoVisitorToken">SsoVisitorToken</a></p> <h5>Derived By</h5> <p>Restricting anyType</p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">CustomerCode </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Uniquely identifies a customer for which this token will be valid <br></td> </tr> <tr class="group0"> <td class="first">Expires </td> <td class="middle">dateTime </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">(UTC) datetime after which this token will become invalid <br></td> </tr> <tr class="group0"> <td class="first">UserName </td> <td class="middle">string </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">Uniquely identifies a user <br></td> </tr> <tr class="group0"> <td class="first">VisitorEmail </td> <td class="middle">string </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">Uniquely identifies a visitor <br></td> </tr> <tr class="group0"> <td class="first">WebcastName </td> <td class="middle">string </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">Indicates a webcast for which this token will be valid <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_SsoUserToken"></a><div class="title"> <h5>Complex Type: SsoUserToken</h5> </div> <div class="body"> <h5>Description</h5> <p>Token containing properties required to generate a user token </p> <h5>Derived By</h5> <p>Restricting anyType</p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Expires </td> <td class="middle">dateTime </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">(UTC) datetime after which this token will become invalid <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_SsoVisitorToken"></a><div class="title"> <h5>Complex Type: SsoVisitorToken</h5> </div> <div class="body"> <h5>Description</h5> <p>Token containing properties required to generate a visitor token </p> <h5>Derived By</h5> <p>Restricting anyType</p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Expires </td> <td class="middle">dateTime </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">(UTC) datetime after which this token will become invalid <br></td> </tr> <tr class="group0"> <td class="first">VisitorEmail </td> <td class="middle">string </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">Uniquely identifies a visitor <br></td> </tr> <tr class="group0"> <td class="first">WebcastCode </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Indicates a webcast for which this token will be valid <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_ValidateTokenIn"></a><div class="title"> <h5>Complex Type: ValidateTokenIn</h5> </div> <div class="body"> <h5>Description</h5> <p>Helper class Contains properties that are required to validate a token </p> <h5>Derived By</h5> <p>Extending <a href="#CT-SsoService-tns_RequestBase">RequestBase</a></p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Token </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Token to be validated <br></td> </tr> <tr class="group0"> <td class="first">WebcastCode </td> <td class="middle">string </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Webcast to which this token belongs <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div><a name="CT-SsoService-tns_ValidateTokenOut"></a><div class="title"> <h5>Complex Type: ValidateTokenOut</h5> </div> <div class="body"> <h5>Description</h5> <p>Helper class Used to check if a token has been succesfully validated </p> <h5>Derived By</h5> <p>Extending <a href="#CT-SsoService-tns_ResponseBase">ResponseBase</a></p> <h5>Content Model</h5> <p>Contains elements as defined in the following table.</p> <table cellspacing="0" class="grouped"> <col width="22%"> <col width="22%"> <col width="12%"> <col width="44%"> <thead> <tr> <th>Component </th> <th>Type </th> <th>Occurs </th> <th>Description </th> </tr> </thead> <tbody> <tr class="startGroup0"> <td class="first"> </td> <td class="middle"> </td> <td class="middle">1..1 </td> <td class="last"> </td> </tr> <tr class="group0"> <td class="first">Result </td> <td class="middle">ResultCode </td> <td class="middle">1..1 </td> <td style="text-align: " class="last">Result of the requested action <br></td> </tr> <tr class="group0"> <td class="first">Errors </td> <td class="middle"><a href="#CT-SsoService-tns_Errors">Errors</a> </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">A list of errors that occurred during the request <br></td> </tr> <tr class="group0"> <td class="first">IsValid </td> <td class="middle">boolean </td> <td class="middle">0..1 </td> <td style="text-align: " class="last">True if valid <br></td> </tr> <tr class="endGroup0"> <td class="first"></td> <td class="middle"></td> <td class="middle"></td> <td class="last"></td> </tr> </tbody> </table> </div>