apidocs/xml_ns0_VXPortalUser.html (489 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: VXPortalUser</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: VXPortalUser</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_VXPortalUser.html">VXPortalUser</a></li>
</ol>
<h1 class="page-header">VXPortalUser <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-configProperties" class="property-name">configProperties</span>
</td>
<td> <span class="datatype-reference">(custom)
</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"> </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-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-groupIdList" class="property-name">groupIdList</span>
</td>
<td> <span class="datatype-reference">list of long
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/unbounded
</span>
</td>
<td> <span class="property-description"> </span>
</td>
</tr>
<tr>
<td> <span id="prop-groupPermissions" class="property-name">groupPermissions</span>
</td>
<td> <span class="datatype-reference">list of <a href="xml_ns0_VXGroupPermission.html">VXGroupPermission</a>
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/unbounded
</span>
</td>
<td> <span class="property-description"> </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-notes" class="property-name">notes</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>notes</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-otherAttributes" class="property-name">otherAttributes</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">String - additional attributes.</span>
</td>
</tr>
<tr>
<td> <span id="prop-password" class="property-name">password</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>password</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-status" class="property-name">status</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>status</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-syncSource" class="property-name">syncSource</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">String - sync Source attribute.</span>
</td>
</tr>
<tr>
<td> <span id="prop-userPermList" class="property-name">userPermList</span>
</td>
<td> <span class="datatype-reference">list of <a href="xml_ns0_VXUserPermission.html">VXUserPermission</a>
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/unbounded
</span>
</td>
<td> <span class="property-description"> </span>
</td>
</tr>
<tr>
<td> <span id="prop-userRoleList" class="property-name">userRoleList</span>
</td>
<td> <span class="datatype-reference">list of string
</span>
</td>
<td> <span class="property-type">element
</span>
</td>
<td> <span class="property-namespaceInfo">
</span>
</td>
<td> <span class="property-minMaxOccurs">0/unbounded
</span>
</td>
<td> <span class="property-description">Returns the value for the member attribute <b>userRoleList</b></span>
</td>
</tr>
<tr>
<td> <span id="prop-userSource" class="property-name">userSource</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>userSource</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"><VXPortalUser>
<loginId>...</loginId>
<password>...</password>
<status>...</status>
<emailAddress>...</emailAddress>
<firstName>...</firstName>
<lastName>...</lastName>
<publicScreenName>...</publicScreenName>
<userSource>...</userSource>
<notes>...</notes>
<userRoleList>...</userRoleList>
<groupIdList>...</groupIdList>
<userPermList>
<userId>...</userId>
<moduleId>...</moduleId>
<isAllowed>...</isAllowed>
<userName>...</userName>
<moduleName>...</moduleName>
<loginId>...</loginId>
<id>...</id>
<createDate>...</createDate>
<updateDate>...</updateDate>
<owner>...</owner>
<updatedBy>...</updatedBy>
</userPermList>
<groupPermissions>
<groupId>...</groupId>
<groupName>...</groupName>
<moduleId>...</moduleId>
<isAllowed>...</isAllowed>
<moduleName>...</moduleName>
<id>...</id>
<createDate>...</createDate>
<updateDate>...</updateDate>
<owner>...</owner>
<updatedBy>...</updatedBy>
</groupPermissions>
<otherAttributes>...</otherAttributes>
<configProperties>...</configProperties>
<syncSource>...</syncSource>
<id>...</id>
<createDate>...</createDate>
<updateDate>...</updateDate>
<owner>...</owner>
<updatedBy>...</updatedBy>
</VXPortalUser>
</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>