Google Git
Sign in
apache / archiva-web-content / 9a87f855e11950826bc2a275e8513794c0129da4 / . / docs / 3.0.0-SNAPSHOT / rest-docs-redback-rest-api / xml_ns0_role.html
blob: 0e96c7021786ad2880f2e1d3255383905cfdcbff [file] [log] [blame]
<!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>Apache Archiva Redback REST API: role</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">
<link href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.css" type="text/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 class="home">
<div class="container">
<header>
<div id="header" class="column first last span-20">
<div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">Apache Archiva Redback REST API: role</a></div>
<div id="primary" class="column span-18 append-1 prepend-1 first last">
<ul class="navigation">
<li id="nav-rest"><a href="resources.html">REST</a></li>
<li id="nav-data"><a href="data.html">Data Model</a></li>
</ul>
</div>
<div>
<ul class="xbreadcrumbs" id="breadcrumbs">
<li>
<a href="index.html" class="home">Home</a> &gt;
</li>
<li>
<a href="syntax_xml.html">XML</a> &gt;
</li>
<li class="current">
<a href="xml_ns0_role.html">role</a>
</li>
</ul>
</div>
</div>
<!--<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">Apache Archiva Redback REST API: role</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>
<li><a href="downloads.html">Files and Libraries</a></li>
</ul>
</div>
</div>
</nav>-->
</header>
<div id="main" class="column first last span-20">
<h1 class="page-header">role <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>
<dt>Available Since</dt>
<dd>1.4</dd>
</dl>
<table class="table">
<caption>Properties</caption>
<thead>
<tr>
<th>name</th>
<th>data type</th>
<th>type</th>
<th>namespace</th>
<th>min/max occurs</th>
<th>constraints</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td> assignable
</td>
<td> boolean
</td>
<td> element
</td>
<td>
</td>
<td> 1/1
</td>
<td> required
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> childRoleNames
</td>
<td> list of string
</td>
<td> element
</td>
<td>
</td>
<td> 0/unbounded
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> description
</td>
<td> string
</td>
<td> element
</td>
<td>
</td>
<td> 0/1
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> name
</td>
<td> string
</td>
<td> element
</td>
<td>
</td>
<td> 0/1
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> otherUsers
</td>
<td> list of <a href="xml_ns0_user.html">user</a>
</td>
<td> element
</td>
<td>
</td>
<td> 0/unbounded
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> parentRoleNames
</td>
<td> list of string
</td>
<td> element
</td>
<td>
</td>
<td> 0/unbounded
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> parentsRolesUsers
</td>
<td> list of <a href="xml_ns0_user.html">user</a>
</td>
<td> element
</td>
<td>
</td>
<td> 0/unbounded
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> permanent
</td>
<td> boolean
</td>
<td> element
</td>
<td>
</td>
<td> 1/1
</td>
<td> required
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> permissions
</td>
<td> list of <a href="xml_ns0_permission.html">permission</a>
</td>
<td> element
</td>
<td>
</td>
<td> 0/unbounded
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> removedUsers
</td>
<td> list of <a href="xml_ns0_user.html">user</a>
</td>
<td> element
</td>
<td>
</td>
<td> 0/unbounded
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
<tr>
<td> users
</td>
<td> list of <a href="xml_ns0_user.html">user</a>
</td>
<td> element
</td>
<td>
</td>
<td> 0/unbounded
</td>
<td> &nbsp;
</td>
<td> &nbsp;
</td>
</tr>
</tbody>
</table>
<h2>Example</h2>
<pre class="prettyprint lang-xml">&lt;role&gt;
&lt;name&gt;...&lt;/name&gt;
&lt;description&gt;...&lt;/description&gt;
&lt;assignable&gt;...&lt;/assignable&gt;
&lt;childRoleNames&gt;...&lt;/childRoleNames&gt;
&lt;permissions&gt;
&lt;name&gt;...&lt;/name&gt;
&lt;operation&gt;
&lt;name&gt;...&lt;/name&gt;
&lt;description&gt;...&lt;/description&gt;
&lt;permanent&gt;...&lt;/permanent&gt;
&lt;/operation&gt;
&lt;resource&gt;
&lt;identifier&gt;...&lt;/identifier&gt;
&lt;pattern&gt;...&lt;/pattern&gt;
&lt;permanent&gt;...&lt;/permanent&gt;
&lt;/resource&gt;
&lt;/permissions&gt;
&lt;permanent&gt;...&lt;/permanent&gt;
&lt;parentRoleNames&gt;...&lt;/parentRoleNames&gt;
&lt;parentsRolesUsers&gt;
&lt;username&gt;...&lt;/username&gt;
&lt;fullName&gt;...&lt;/fullName&gt;
&lt;email&gt;...&lt;/email&gt;
&lt;validated&gt;...&lt;/validated&gt;
&lt;locked&gt;...&lt;/locked&gt;
&lt;password&gt;...&lt;/password&gt;
&lt;passwordChangeRequired&gt;...&lt;/passwordChangeRequired&gt;
&lt;permanent&gt;...&lt;/permanent&gt;
&lt;confirmPassword&gt;...&lt;/confirmPassword&gt;
&lt;timestampAccountCreation&gt;...&lt;/timestampAccountCreation&gt;
&lt;timestampLastLogin&gt;...&lt;/timestampLastLogin&gt;
&lt;timestampLastPasswordChange&gt;...&lt;/timestampLastPasswordChange&gt;
&lt;previousPassword&gt;...&lt;/previousPassword&gt;
&lt;assignedRoles&gt;...&lt;/assignedRoles&gt;
&lt;readOnly&gt;...&lt;/readOnly&gt;
&lt;userManagerId&gt;...&lt;/userManagerId&gt;
&lt;validationToken&gt;...&lt;/validationToken&gt;
&lt;/parentsRolesUsers&gt;
&lt;users&gt;
&lt;username&gt;...&lt;/username&gt;
&lt;fullName&gt;...&lt;/fullName&gt;
&lt;email&gt;...&lt;/email&gt;
&lt;validated&gt;...&lt;/validated&gt;
&lt;locked&gt;...&lt;/locked&gt;
&lt;password&gt;...&lt;/password&gt;
&lt;passwordChangeRequired&gt;...&lt;/passwordChangeRequired&gt;
&lt;permanent&gt;...&lt;/permanent&gt;
&lt;confirmPassword&gt;...&lt;/confirmPassword&gt;
&lt;timestampAccountCreation&gt;...&lt;/timestampAccountCreation&gt;
&lt;timestampLastLogin&gt;...&lt;/timestampLastLogin&gt;
&lt;timestampLastPasswordChange&gt;...&lt;/timestampLastPasswordChange&gt;
&lt;previousPassword&gt;...&lt;/previousPassword&gt;
&lt;assignedRoles&gt;...&lt;/assignedRoles&gt;
&lt;readOnly&gt;...&lt;/readOnly&gt;
&lt;userManagerId&gt;...&lt;/userManagerId&gt;
&lt;validationToken&gt;...&lt;/validationToken&gt;
&lt;/users&gt;
&lt;otherUsers&gt;
&lt;username&gt;...&lt;/username&gt;
&lt;fullName&gt;...&lt;/fullName&gt;
&lt;email&gt;...&lt;/email&gt;
&lt;validated&gt;...&lt;/validated&gt;
&lt;locked&gt;...&lt;/locked&gt;
&lt;password&gt;...&lt;/password&gt;
&lt;passwordChangeRequired&gt;...&lt;/passwordChangeRequired&gt;
&lt;permanent&gt;...&lt;/permanent&gt;
&lt;confirmPassword&gt;...&lt;/confirmPassword&gt;
&lt;timestampAccountCreation&gt;...&lt;/timestampAccountCreation&gt;
&lt;timestampLastLogin&gt;...&lt;/timestampLastLogin&gt;
&lt;timestampLastPasswordChange&gt;...&lt;/timestampLastPasswordChange&gt;
&lt;previousPassword&gt;...&lt;/previousPassword&gt;
&lt;assignedRoles&gt;...&lt;/assignedRoles&gt;
&lt;readOnly&gt;...&lt;/readOnly&gt;
&lt;userManagerId&gt;...&lt;/userManagerId&gt;
&lt;validationToken&gt;...&lt;/validationToken&gt;
&lt;/otherUsers&gt;
&lt;removedUsers&gt;
&lt;username&gt;...&lt;/username&gt;
&lt;fullName&gt;...&lt;/fullName&gt;
&lt;email&gt;...&lt;/email&gt;
&lt;validated&gt;...&lt;/validated&gt;
&lt;locked&gt;...&lt;/locked&gt;
&lt;password&gt;...&lt;/password&gt;
&lt;passwordChangeRequired&gt;...&lt;/passwordChangeRequired&gt;
&lt;permanent&gt;...&lt;/permanent&gt;
&lt;confirmPassword&gt;...&lt;/confirmPassword&gt;
&lt;timestampAccountCreation&gt;...&lt;/timestampAccountCreation&gt;
&lt;timestampLastLogin&gt;...&lt;/timestampLastLogin&gt;
&lt;timestampLastPasswordChange&gt;...&lt;/timestampLastPasswordChange&gt;
&lt;previousPassword&gt;...&lt;/previousPassword&gt;
&lt;assignedRoles&gt;...&lt;/assignedRoles&gt;
&lt;readOnly&gt;...&lt;/readOnly&gt;
&lt;userManagerId&gt;...&lt;/userManagerId&gt;
&lt;validationToken&gt;...&lt;/validationToken&gt;
&lt;/removedUsers&gt;
&lt;/role&gt;
</pre>
<footer>
<div class="footer">
Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.
</div>
</footer>
</div>
</div>
<!-- JavaScript placed at the end of the document so the pages load faster. -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.js" type="text/javascript"></script>
</body>
</html>