apidocs/xml_ns0_VXAuthSession.html (504 lines of code) (raw):

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <title>Ranger REST API: VXAuthSession</title> <!-- Mobile viewport optimized: j.mp/bplateviewport --> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- Bootstrap core CSS --> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> <link rel="stylesheet" href="css/enunciate.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> <![endif]--> </head> <body data-spy="scroll" data-target="#apinav"> <nav class="navbar navbar-inverse navbar-fixed-top"> <div class="container-fluid"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="index.html">Ranger REST API: VXAuthSession</a> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="resources.html">Resources</a></li> <li><a href="data.html">Data Types</a></li> </ul> </div> </div> </nav> <div class="container-fluid"> <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> <ol class="breadcrumb" id="top"> <li class="active dropdown"><a href="index.html">Home</a></li> <li class="active dropdown"><a href="syntax_xml.html">XML</a></li> <li class="dropdown"><a href="xml_ns0_VXAuthSession.html">VXAuthSession</a></li> </ol> <h1 class="page-header">VXAuthSession <small>Data Type</small></h1> <p></p> <dl class="dl-horizontal"> <dt>Namespace</dt> <dd>(Default)</dd> <dt>Schema</dt> <dd><a href="ns0.xsd">ns0.xsd</a></dd> </dl> <table class="table datatype-properties"> <caption>Properties</caption> <thead> <tr> <th>name</th> <th>data type</th> <th>type</th> <th>namespace</th> <th>min/max occurs</th> <th>description</th> </tr> </thead> <tbody> <tr> <td> <span id="prop-authProvider" class="property-name">authProvider</span> </td> <td> <span class="datatype-reference">int </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">1/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>authProvider</b></span> </td> </tr> <tr> <td> <span id="prop-authStatus" class="property-name">authStatus</span> </td> <td> <span class="datatype-reference">int </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">1/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>authStatus</b></span> </td> </tr> <tr> <td> <span id="prop-authTime" class="property-name">authTime</span> </td> <td> <span class="datatype-reference">dateTime </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>authTime</b></span> </td> </tr> <tr> <td> <span id="prop-authType" class="property-name">authType</span> </td> <td> <span class="datatype-reference">int </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">1/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>authType</b></span> </td> </tr> <tr> <td> <span id="prop-cityName" class="property-name">cityName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>cityName</b></span> </td> </tr> <tr> <td> <span id="prop-countryName" class="property-name">countryName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>countryName</b></span> </td> </tr> <tr> <td> <span id="prop-deviceType" class="property-name">deviceType</span> </td> <td> <span class="datatype-reference">int </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">1/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>deviceType</b></span> </td> </tr> <tr> <td> <span id="prop-emailAddress" class="property-name">emailAddress</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>emailAddress</b></span> </td> </tr> <tr> <td> <span id="prop-familyScreenName" class="property-name">familyScreenName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>familyScreenName</b></span> </td> </tr> <tr> <td> <span id="prop-firstName" class="property-name">firstName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>firstName</b></span> </td> </tr> <tr> <td> <span id="prop-isTestUser" class="property-name">isTestUser</span> </td> <td> <span class="datatype-reference">boolean </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">1/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>isTestUser</b></span> </td> </tr> <tr> <td> <span id="prop-lastName" class="property-name">lastName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>lastName</b></span> </td> </tr> <tr> <td> <span id="prop-loginId" class="property-name">loginId</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>loginId</b></span> </td> </tr> <tr> <td> <span id="prop-publicScreenName" class="property-name">publicScreenName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>publicScreenName</b></span> </td> </tr> <tr> <td> <span id="prop-requestIP" class="property-name">requestIP</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>requestIP</b></span> </td> </tr> <tr> <td> <span id="prop-requestUserAgent" class="property-name">requestUserAgent</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>requestUserAgent</b></span> </td> </tr> <tr> <td> <span id="prop-stateName" class="property-name">stateName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>stateName</b></span> </td> </tr> <tr> <td> <span id="prop-userId" class="property-name">userId</span> </td> <td> <span class="datatype-reference">long </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">Returns the value for the member attribute <b>userId</b></span> </td> </tr> </tbody> <tr> <td colspan="6"><h5 class="text-muted">Properties inherited from <a href="xml_ns0_VXDataObject.html">VXDataObject</a></h5></td> </tr> <tbody> <tr> <td><span class="property-name">createDate</span></td> <td><span class="datatype-reference">dateTime </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">Returns the value for the member attribute <b>createDate</b></span></td> </tr> <tr> <td><span class="property-name">id</span></td> <td><span class="datatype-reference">long </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">Returns the value for the member attribute <b>id</b></span></td> </tr> <tr> <td><span class="property-name">owner</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">Returns the value for the member attribute <b>owner</b></span></td> </tr> <tr> <td><span class="property-name">updateDate</span></td> <td><span class="datatype-reference">dateTime </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">Returns the value for the member attribute <b>updateDate</b></span></td> </tr> <tr> <td><span class="property-name">updatedBy</span></td> <td><span class="datatype-reference">string </span></td> <td><span class="property-type">element </span></td> <td><span class="property-namespaceInfo"> </span></td> <td><span class="property-minMaxOccurs">0/1 </span></td> <td><span class="property-description">Returns the value for the member attribute <b>updatedBy</b></span></td> </tr> </tbody> </table> <p class="lead">Example</p> <pre class="prettyprint language-xml example">&lt;VXAuthSession&gt; &lt;loginId&gt;...&lt;/loginId&gt; &lt;userId&gt;...&lt;/userId&gt; &lt;emailAddress&gt;...&lt;/emailAddress&gt; &lt;isTestUser&gt;...&lt;/isTestUser&gt; &lt;firstName&gt;...&lt;/firstName&gt; &lt;lastName&gt;...&lt;/lastName&gt; &lt;publicScreenName&gt;...&lt;/publicScreenName&gt; &lt;familyScreenName&gt;...&lt;/familyScreenName&gt; &lt;authTime&gt;...&lt;/authTime&gt; &lt;authStatus&gt;...&lt;/authStatus&gt; &lt;authType&gt;...&lt;/authType&gt; &lt;authProvider&gt;...&lt;/authProvider&gt; &lt;deviceType&gt;...&lt;/deviceType&gt; &lt;requestIP&gt;...&lt;/requestIP&gt; &lt;cityName&gt;...&lt;/cityName&gt; &lt;stateName&gt;...&lt;/stateName&gt; &lt;countryName&gt;...&lt;/countryName&gt; &lt;requestUserAgent&gt;...&lt;/requestUserAgent&gt; &lt;id&gt;...&lt;/id&gt; &lt;createDate&gt;...&lt;/createDate&gt; &lt;updateDate&gt;...&lt;/updateDate&gt; &lt;owner&gt;...&lt;/owner&gt; &lt;updatedBy&gt;...&lt;/updatedBy&gt; &lt;/VXAuthSession&gt; </pre> <footer class="footer"> <div class="container"> <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> </div> </footer> </div> </div> </div> <!-- JavaScript placed at the end of the document so the pages load faster. --> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> <!-- Bootstrap core JavaScript ================================================== --> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> <script> $(function() { $(".clickable-row").click(function() { window.document.location = $(this).data("href"); }); $('[data-toggle="tooltip"]').tooltip() }); </script> </body> </html>