Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / org / apache / archiva / redback / rest / api / services / v2 / UserService.html
blob: 80ccb4e55d87b31e32c900a89e4fa79f781a1ad1 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>UserService (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UserService (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UserService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.archiva.redback.rest.api.services.v2</a></div>
<h2 title="Interface UserService" class="title">Interface UserService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../../services/v2/DefaultUserService.html" title="class in org.apache.archiva.redback.rest.services.v2">DefaultUserService</a></code></dd>
</dl>
<hr>
<pre>@Path("/users")
public interface <a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.73">UserService</a></pre>
<div class="block">Service interface for user management</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#changePassword(org.apache.archiva.redback.rest.api.model.v2.PasswordChange)">changePassword</a></span>&#8203;(<a href="../../model/v2/PasswordChange.html" title="class in org.apache.archiva.redback.rest.api.model.v2">PasswordChange</a>&nbsp;passwordChange)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#changePasswordUnauthenticated(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.PasswordChange)">changePasswordUnauthenticated</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
<a href="../../model/v2/PasswordChange.html" title="class in org.apache.archiva.redback.rest.api.model.v2">PasswordChange</a>&nbsp;passwordChange)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearRequirePasswordChangeFlag(java.lang.String)">clearRequirePasswordChangeFlag</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAdminUser(org.apache.archiva.redback.rest.api.model.v2.User)">createAdminUser</a></span>&#8203;(<a href="../../model/v2/User.html" title="class in org.apache.archiva.redback.rest.api.model.v2">User</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">will create admin user only if not exists !! if exists will return false</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createUser(org.apache.archiva.redback.rest.api.model.v2.User)">createUser</a></span>&#8203;(<a href="../../model/v2/User.html" title="class in org.apache.archiva.redback.rest.api.model.v2">User</a>&nbsp;user)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteUser(java.lang.String)">deleteUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../model/v2/AvailabilityStatus.html" title="class in org.apache.archiva.redback.rest.api.model.v2">AvailabilityStatus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdminStatus()">getAdminStatus</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Operation.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Operation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentUserOperations()">getCurrentUserOperations</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Permission.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Permission</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentUserPermissions()">getCurrentUserPermissions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEffectivelyAssignedRoles(java.lang.String)">getEffectivelyAssignedRoles</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)</code></th>
<td class="colLast">
<div class="block">Returns all roles for a given user id.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Permission.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Permission</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGuestPermissions()">getGuestPermissions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoggedInUser()">getLoggedInUser</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../model/v2/RoleTree.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleTree</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoleTree(java.lang.String)">getRoleTree</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUser(java.lang.String)">getUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Operation.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Operation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserOperations(java.lang.String)">getUserOperations</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Permission.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Permission</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserPermissions(java.lang.String)">getUserPermissions</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>org.apache.archiva.components.rest.model.PagedResult&lt;<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsers(java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">getUsers</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;searchTerm,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&nbsp;offset,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&nbsp;limit,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;orderBy,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;order)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lockUser(java.lang.String)">lockUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../model/v2/PingResult.html" title="class in org.apache.archiva.redback.rest.api.model.v2">PingResult</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ping()">ping</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../model/v2/RegistrationKey.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RegistrationKey</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerUser(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.UserRegistrationRequest)">registerUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
<a href="../../model/v2/UserRegistrationRequest.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserRegistrationRequest</a>&nbsp;userRegistrationRequest)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFromCache(java.lang.String)">removeFromCache</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetPassword(java.lang.String)">resetPassword</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">
<div class="block">Asks for a password reset of the given User.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRequirePasswordChangeFlag(java.lang.String)">setRequirePasswordChangeFlag</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unlockUser(java.lang.String)">unlockUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateMe(org.apache.archiva.redback.rest.api.model.v2.SelfUserData)">updateMe</a></span>&#8203;(<a href="../../model/v2/SelfUserData.html" title="class in org.apache.archiva.redback.rest.api.model.v2">SelfUserData</a>&nbsp;user)</code></th>
<td class="colLast">
<div class="block">Update only the current logged in user and this fields: fullname, email, password.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateUser(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.User)">updateUser</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
<a href="../../model/v2/User.html" title="class in org.apache.archiva.redback.rest.api.model.v2">User</a>&nbsp;user)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../model/v2/VerificationStatus.html" title="class in org.apache.archiva.redback.rest.api.model.v2">VerificationStatus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateUserRegistration(java.lang.String,java.lang.String)">validateUserRegistration</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre class="methodSignature">@Path("{userId}")
@GET
@Produces("application/json")
<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.79">getUser</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="getUsers(java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsers</h4>
<pre class="methodSignature">@Path("")
@GET
@Produces("application/json")
org.apache.archiva.components.rest.model.PagedResult&lt;<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.106">getUsers</a>&#8203;(@QueryParam("q") @DefaultValue("")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;searchTerm,
@QueryParam("offset") @DefaultValue("0")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&nbsp;offset,
@QueryParam("limit") @DefaultValue("100")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>&nbsp;limit,
@QueryParam("orderBy") @DefaultValue("id")
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;orderBy,
@QueryParam("order") @DefaultValue("asc")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;order)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="createUser(org.apache.archiva.redback.rest.api.model.v2.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createUser</h4>
<pre class="methodSignature">@Path("")
@POST
@Produces("application/json")
@Consumes("application/json")
<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.139">createUser</a>&#8203;(<a href="../../model/v2/User.html" title="class in org.apache.archiva.redback.rest.api.model.v2">User</a>&nbsp;user)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="deleteUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteUser</h4>
<pre class="methodSignature">@Path("{userId}")
@DELETE
@Produces("application/json")
void&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.170">deleteUser</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="updateUser(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateUser</h4>
<pre class="methodSignature">@Path("{userId}")
@PUT
@Produces("application/json")
<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.191">updateUser</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
<a href="../../model/v2/User.html" title="class in org.apache.archiva.redback.rest.api.model.v2">User</a>&nbsp;user)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="createAdminUser(org.apache.archiva.redback.rest.api.model.v2.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAdminUser</h4>
<pre class="methodSignature">@Path("admin")
@POST
@Produces("application/json")
@Consumes("application/json")
<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.220">createAdminUser</a>&#8203;(<a href="../../model/v2/User.html" title="class in org.apache.archiva.redback.rest.api.model.v2">User</a>&nbsp;user)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<div class="block">will create admin user only if not exists !! if exists will return false</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="getAdminStatus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdminStatus</h4>
<pre class="methodSignature">@Path("admin/status")
@GET
@Produces("application/json")
<a href="../../model/v2/AvailabilityStatus.html" title="class in org.apache.archiva.redback.rest.api.model.v2">AvailabilityStatus</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.246">getAdminStatus</a>()
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="lockUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lockUser</h4>
<pre class="methodSignature">@Path("{userId}/lock/set")
@POST
@Produces("application/json")
void&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.265">lockUser</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="unlockUser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unlockUser</h4>
<pre class="methodSignature">@Path("{userId}/lock/clear")
@POST
@Produces("application/json")
void&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.288">unlockUser</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="setRequirePasswordChangeFlag(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequirePasswordChangeFlag</h4>
<pre class="methodSignature">@Path("{userId}/password/require/set")
@POST
@Produces("application/json")
void&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.312">setRequirePasswordChangeFlag</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="clearRequirePasswordChangeFlag(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearRequirePasswordChangeFlag</h4>
<pre class="methodSignature">@Path("{userId}/password/require/clear")
@POST
@Produces("application/json")
void&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.336">clearRequirePasswordChangeFlag</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="updateMe(org.apache.archiva.redback.rest.api.model.v2.SelfUserData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateMe</h4>
<pre class="methodSignature">@Path("me")
@PUT
@Produces("application/json")
<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.364">updateMe</a>&#8203;(<a href="../../model/v2/SelfUserData.html" title="class in org.apache.archiva.redback.rest.api.model.v2">SelfUserData</a>&nbsp;user)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<div class="block">Update only the current logged in user and this fields: fullname, email, password.
The service verifies the current logged user with the one passed in the method</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the user info object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="getLoggedInUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoggedInUser</h4>
<pre class="methodSignature">@Path("me")
@GET
@Produces("application/json")
<a href="../../model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.383">getLoggedInUser</a>()
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="ping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ping</h4>
<pre class="methodSignature">@Path("___ping___")
@GET
@Produces("application/json")
<a href="../../model/v2/PingResult.html" title="class in org.apache.archiva.redback.rest.api.model.v2">PingResult</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.399">ping</a>()
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="removeFromCache(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFromCache</h4>
<pre class="methodSignature">@Path("{userId}/cache/clear")
@POST
@Produces("application/json")
javax.ws.rs.core.Response&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.413">removeFromCache</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="registerUser(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.UserRegistrationRequest)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerUser</h4>
<pre class="methodSignature">@Path("{userId}/register")
@POST
@Produces("application/json")
<a href="../../model/v2/RegistrationKey.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RegistrationKey</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.440">registerUser</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
<a href="../../model/v2/UserRegistrationRequest.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserRegistrationRequest</a>&nbsp;userRegistrationRequest)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the registration key</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="resetPassword(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetPassword</h4>
<pre class="methodSignature">@Path("{userId}/password/reset")
@POST
@Produces("application/json")
@Consumes("application/json")
javax.ws.rs.core.Response&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.461">resetPassword</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<div class="block">Asks for a password reset of the given User. Normally this results in a password reset email sent to the
stored email address for the given user.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="getUserPermissions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserPermissions</h4>
<pre class="methodSignature">@Path("{userId}/permissions")
@GET
@Produces("application/json")
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Permission.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Permission</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.482">getUserPermissions</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userName)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="getGuestPermissions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGuestPermissions</h4>
<pre class="methodSignature">@Path("guest/permissions")
@GET
@Produces("application/json")
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Permission.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Permission</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.506">getGuestPermissions</a>()
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="getUserOperations(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserOperations</h4>
<pre class="methodSignature">@Path("{userId}/operations")
@GET
@Produces("application/json")
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Operation.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Operation</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.525">getUserOperations</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userName)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="getCurrentUserPermissions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentUserPermissions</h4>
<pre class="methodSignature">@Path("me/permissions")
@GET
@Produces("application/json")
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Permission.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Permission</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.553">getCurrentUserPermissions</a>()
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current logged user permissions, if no logged user guest permissions are returned</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="getCurrentUserOperations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentUserOperations</h4>
<pre class="methodSignature">@Path("me/operations")
@GET
@Produces("application/json")
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../../model/v2/Operation.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Operation</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.573">getCurrentUserOperations</a>()
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current logged user operations, if no logged user guest operations are returned</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="validateUserRegistration(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateUserRegistration</h4>
<pre class="methodSignature">@Path("{userId}/register/{key}/validate")
@POST
@Produces("application/json")
<a href="../../model/v2/VerificationStatus.html" title="class in org.apache.archiva.redback.rest.api.model.v2">VerificationStatus</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.590">validateUserRegistration</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
@PathParam("key")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;key)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="getEffectivelyAssignedRoles(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEffectivelyAssignedRoles</h4>
<pre class="methodSignature">@Path("{userId}/roles")
@GET
@Produces("application/json")
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../../model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a>&gt;&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.613">getEffectivelyAssignedRoles</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<div class="block">Returns all roles for a given user id. Recurses all child roles.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="getRoleTree(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoleTree</h4>
<pre class="methodSignature">@Path("{userId}/roletree")
@GET
@Produces("application/json")
<a href="../../model/v2/RoleTree.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleTree</a>&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.637">getRoleTree</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="changePassword(org.apache.archiva.redback.rest.api.model.v2.PasswordChange)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changePassword</h4>
<pre class="methodSignature">@Path("me/password/update")
@POST
@Consumes("application/json")
javax.ws.rs.core.Response&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.662">changePassword</a>&#8203;(<a href="../../model/v2/PasswordChange.html" title="class in org.apache.archiva.redback.rest.api.model.v2">PasswordChange</a>&nbsp;passwordChange)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
<a id="changePasswordUnauthenticated(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.PasswordChange)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>changePasswordUnauthenticated</h4>
<pre class="methodSignature">@Path("{userId}/password/update")
@POST
@Consumes("application/json")
javax.ws.rs.core.Response&nbsp;<a href="../../../../../../../../src-html/org/apache/archiva/redback/rest/api/services/v2/UserService.html#line.684">changePasswordUnauthenticated</a>&#8203;(@PathParam("userId")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;userId,
<a href="../../model/v2/PasswordChange.html" title="class in org.apache.archiva.redback.rest.api.model.v2">PasswordChange</a>&nbsp;passwordChange)
throws <a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UserService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>