| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.rest.api.services.v2;</a> |
| <span class="sourceLineNo">002</span><a id="line.2">/*</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> *</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> *</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * under the License.</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> */</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import io.swagger.v3.oas.annotations.Operation;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import io.swagger.v3.oas.annotations.Parameter;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import io.swagger.v3.oas.annotations.headers.Header;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import io.swagger.v3.oas.annotations.media.Content;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import io.swagger.v3.oas.annotations.media.Schema;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import io.swagger.v3.oas.annotations.responses.ApiResponse;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import io.swagger.v3.oas.annotations.security.SecurityRequirement;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import io.swagger.v3.oas.annotations.tags.Tag;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.components.rest.model.PagedResult;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.authorization.RedbackAuthorization;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.integration.security.role.RedbackRoleConstants;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import org.apache.archiva.redback.rest.api.model.RedbackRestError;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import org.apache.archiva.redback.rest.api.model.v2.Role;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import org.apache.archiva.redback.rest.api.model.v2.RoleInfo;</a> |
| <span class="sourceLineNo">035</span><a id="line.35">import org.apache.archiva.redback.rest.api.model.v2.RoleTemplate;</a> |
| <span class="sourceLineNo">036</span><a id="line.36">import org.apache.archiva.redback.rest.api.model.v2.UserInfo;</a> |
| <span class="sourceLineNo">037</span><a id="line.37">import org.apache.archiva.redback.rest.api.services.RedbackServiceException;</a> |
| <span class="sourceLineNo">038</span><a id="line.38"></a> |
| <span class="sourceLineNo">039</span><a id="line.39">import javax.ws.rs.DELETE;</a> |
| <span class="sourceLineNo">040</span><a id="line.40">import javax.ws.rs.DefaultValue;</a> |
| <span class="sourceLineNo">041</span><a id="line.41">import javax.ws.rs.GET;</a> |
| <span class="sourceLineNo">042</span><a id="line.42">import javax.ws.rs.HEAD;</a> |
| <span class="sourceLineNo">043</span><a id="line.43">import javax.ws.rs.PATCH;</a> |
| <span class="sourceLineNo">044</span><a id="line.44">import javax.ws.rs.POST;</a> |
| <span class="sourceLineNo">045</span><a id="line.45">import javax.ws.rs.PUT;</a> |
| <span class="sourceLineNo">046</span><a id="line.46">import javax.ws.rs.Path;</a> |
| <span class="sourceLineNo">047</span><a id="line.47">import javax.ws.rs.PathParam;</a> |
| <span class="sourceLineNo">048</span><a id="line.48">import javax.ws.rs.Produces;</a> |
| <span class="sourceLineNo">049</span><a id="line.49">import javax.ws.rs.QueryParam;</a> |
| <span class="sourceLineNo">050</span><a id="line.50">import javax.ws.rs.core.Response;</a> |
| <span class="sourceLineNo">051</span><a id="line.51">import java.util.List;</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53">import static javax.ws.rs.core.MediaType.APPLICATION_JSON;</a> |
| <span class="sourceLineNo">054</span><a id="line.54">import static org.apache.archiva.redback.rest.api.Constants.DEFAULT_PAGE_LIMIT;</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56">/**</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> *</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * Service interface for role management.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> *</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @author Olivier Lamy</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @author Martin Stockhammer</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @since 3.0</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> */</a> |
| <span class="sourceLineNo">064</span><a id="line.64">@Path( "/roles" )</a> |
| <span class="sourceLineNo">065</span><a id="line.65">@Tag(name = "v2")</a> |
| <span class="sourceLineNo">066</span><a id="line.66">@Tag(name = "v2/Roles")</a> |
| <span class="sourceLineNo">067</span><a id="line.67">@SecurityRequirement(name = "BearerAuth")</a> |
| <span class="sourceLineNo">068</span><a id="line.68">public interface RoleService</a> |
| <span class="sourceLineNo">069</span><a id="line.69">{</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"> @Path( "" )</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> @GET</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> @Operation( summary = "Returns all roles defined. The result is paged.",</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> parameters = {</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> @Parameter(name = "q", description = "Search term"),</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> @Parameter(name = "offset", description = "The offset of the first element returned"),</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> @Parameter(name = "limit", description = "Maximum number of items to return in the response"),</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> @Parameter(name = "orderBy", description = "List of attribute used for sorting (id, name, description, assignable)"),</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> @Parameter(name = "order", description = "The sort order. Either ascending (asc) or descending (desc)")</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> },</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> security = {</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> @SecurityRequirement(</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> )</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> },</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> responses = {</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> description = "If the list could be returned",</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = PagedResult.class))</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> ),</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> @ApiResponse( responseCode = "403", description = "Authenticated user is not permitted to gather the information",</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> )</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> PagedResult<RoleInfo> getAllRoles( @QueryParam("q") @DefaultValue( "" ) String searchTerm,</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> @QueryParam( "offset" ) @DefaultValue( "0" ) Integer offset,</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> @QueryParam( "limit" ) @DefaultValue( value = DEFAULT_PAGE_LIMIT ) Integer limit,</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> @QueryParam( "orderBy") @DefaultValue( "id" ) List<String> orderBy,</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> @QueryParam("order") @DefaultValue( "asc" ) String order)</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">103</span><a id="line.103"></a> |
| <span class="sourceLineNo">104</span><a id="line.104"> @Path( "{roleId}" )</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> @GET</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> @Operation( summary = "Returns the definition about a specific role.",</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> security = {</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> @SecurityRequirement(</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> )</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> },</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> responses = {</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> description = "If role was found in the database",</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RoleInfo.class))</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> ),</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> @ApiResponse( responseCode = "404", description = "Role does not exist",</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class ))</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> ),</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> @ApiResponse( responseCode = "403", description = "Authenticated user is not permitted to gather the information",</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> }</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> )</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> RoleInfo getRole( @PathParam( "roleId" ) String roleId )</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">128</span><a id="line.128"></a> |
| <span class="sourceLineNo">129</span><a id="line.129"> @Path( "{roleId}" )</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> @HEAD</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> @Operation( summary = "Checks, if the role with the given id exists.",</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> security = {</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> @SecurityRequirement(</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> )</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> },</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> responses = {</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> description = "If role was found in the database"</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> ),</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> @ApiResponse( responseCode = "404", description = "Role does not exist",</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class ))</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> ),</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> @ApiResponse( responseCode = "403", description = "Authenticated user is not permitted to gather the information",</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> }</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> )</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> Response checkRole( @PathParam( "roleId" ) String roleId )</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">152</span><a id="line.152"></a> |
| <span class="sourceLineNo">153</span><a id="line.153"></a> |
| <span class="sourceLineNo">154</span><a id="line.154"> /**</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> * Moves a templated role from one resource to another resource</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> * @TODO: Not sure, if it makes sense to keep the child template at the source. Shouldn't we move the childs too?</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> *</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * @param templateId the template identifier</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> * @param oldResource the resource of the current role</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> * @param newResource the resource of the new role</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> */</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> @Path( "templates/{templateId}/{oldResource}/moveto/{newResource}" )</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> @POST</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> @Produces( {APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> @Operation( summary = "Moves a templated role from one resource to another resource. If the template has child templates," +</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> " then child instances will be created on for the destination resource. But the child instances on the source are not deleted.",</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> security = {</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> @SecurityRequirement(</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> )</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> },</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> responses = {</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> @ApiResponse( responseCode = "201",</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> description = "If user creation was successful",</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> headers = {</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> @Header( name="Location", description = "The URL of the moved role", schema = @Schema(type="string"))</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> },</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RoleInfo.class))</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> ),</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> @ApiResponse( responseCode = "404", description = "The source role does not exist" ),</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> @ApiResponse( responseCode = "303", description = "The destination role exists already" ),</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission to move the role.",</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">185</span><a id="line.185"></a> |
| <span class="sourceLineNo">186</span><a id="line.186"> }</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> )</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> RoleInfo moveTemplatedRole( @PathParam( "templateId" ) String templateId, @PathParam( "oldResource" ) String oldResource,</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> @PathParam( "newResource" ) String newResource )</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">191</span><a id="line.191"></a> |
| <span class="sourceLineNo">192</span><a id="line.192"> @Path( "templates/{templateId}/{resource}" )</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> @HEAD</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> @Produces( { APPLICATION_JSON} )</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> @Operation( summary = "Checks, if a instance of the role template exists for the given resource",</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> security = {</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> @SecurityRequirement(</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> )</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> },</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> responses = {</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> description = "If the role instance exists"</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> ),</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> @ApiResponse( responseCode = "404", description = "Role does not exist",</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class ))</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> ),</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> @ApiResponse( responseCode = "403", description = "Authenticated user is not permitted to gather the information",</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">211</span><a id="line.211"> }</a> |
| <span class="sourceLineNo">212</span><a id="line.212"> )</a> |
| <span class="sourceLineNo">213</span><a id="line.213"> Response checkTemplateRole( @PathParam( "templateId" ) String templateId,</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> @PathParam( "resource" ) String resource )</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">216</span><a id="line.216"></a> |
| <span class="sourceLineNo">217</span><a id="line.217"> @Path( "templates/{templateId}/{resource}" )</a> |
| <span class="sourceLineNo">218</span><a id="line.218"> @PUT</a> |
| <span class="sourceLineNo">219</span><a id="line.219"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">220</span><a id="line.220"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> @Operation( summary = "Creates a role instance from a template for the given resource",</a> |
| <span class="sourceLineNo">222</span><a id="line.222"> security = {</a> |
| <span class="sourceLineNo">223</span><a id="line.223"> @SecurityRequirement(</a> |
| <span class="sourceLineNo">224</span><a id="line.224"> name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION</a> |
| <span class="sourceLineNo">225</span><a id="line.225"> )</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> },</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> responses = {</a> |
| <span class="sourceLineNo">228</span><a id="line.228"> @ApiResponse( responseCode = "201",</a> |
| <span class="sourceLineNo">229</span><a id="line.229"> description = "If user creation was successful",</a> |
| <span class="sourceLineNo">230</span><a id="line.230"> headers = {</a> |
| <span class="sourceLineNo">231</span><a id="line.231"> @Header( name = "Location", description = "The URL of the created role", schema = @Schema( type = "string" ) )</a> |
| <span class="sourceLineNo">232</span><a id="line.232"> },</a> |
| <span class="sourceLineNo">233</span><a id="line.233"> content = @Content( mediaType = APPLICATION_JSON, schema = @Schema( implementation = RoleInfo.class ) )</a> |
| <span class="sourceLineNo">234</span><a id="line.234"> ),</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> description = "If the role instance existed before and was updated",</a> |
| <span class="sourceLineNo">237</span><a id="line.237"> headers = {</a> |
| <span class="sourceLineNo">238</span><a id="line.238"> @Header( name = "Location", description = "The URL of the updated role", schema = @Schema( type = "string" ) )</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> },</a> |
| <span class="sourceLineNo">240</span><a id="line.240"> content = @Content( mediaType = APPLICATION_JSON, schema = @Schema( implementation = RoleInfo.class ) )</a> |
| <span class="sourceLineNo">241</span><a id="line.241"> ),</a> |
| <span class="sourceLineNo">242</span><a id="line.242"> @ApiResponse( responseCode = "404", description = "The template does not exist" ),</a> |
| <span class="sourceLineNo">243</span><a id="line.243"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role creation.",</a> |
| <span class="sourceLineNo">244</span><a id="line.244"> content = @Content( mediaType = APPLICATION_JSON, schema = @Schema( implementation = RedbackRestError.class ) ) )</a> |
| <span class="sourceLineNo">245</span><a id="line.245"></a> |
| <span class="sourceLineNo">246</span><a id="line.246"> }</a> |
| <span class="sourceLineNo">247</span><a id="line.247"> )</a> |
| <span class="sourceLineNo">248</span><a id="line.248"> RoleInfo createTemplatedRole( @PathParam( "templateId" ) String templateId,</a> |
| <span class="sourceLineNo">249</span><a id="line.249"> @PathParam( "resource" ) String resource )</a> |
| <span class="sourceLineNo">250</span><a id="line.250"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">251</span><a id="line.251"></a> |
| <span class="sourceLineNo">252</span><a id="line.252"> /**</a> |
| <span class="sourceLineNo">253</span><a id="line.253"> * Removes a role corresponding to the role Id that was manufactured with the given resource</a> |
| <span class="sourceLineNo">254</span><a id="line.254"> * it also removes any user assignments for that role</a> |
| <span class="sourceLineNo">255</span><a id="line.255"> *</a> |
| <span class="sourceLineNo">256</span><a id="line.256"> * @param templateId</a> |
| <span class="sourceLineNo">257</span><a id="line.257"> * @param resource</a> |
| <span class="sourceLineNo">258</span><a id="line.258"> */</a> |
| <span class="sourceLineNo">259</span><a id="line.259"> @Path( "templates/{templateId}/{resource}" )</a> |
| <span class="sourceLineNo">260</span><a id="line.260"> @DELETE</a> |
| <span class="sourceLineNo">261</span><a id="line.261"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">262</span><a id="line.262"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">263</span><a id="line.263"> @Operation( summary = "Deletes a role template instance",</a> |
| <span class="sourceLineNo">264</span><a id="line.264"> security = {</a> |
| <span class="sourceLineNo">265</span><a id="line.265"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">266</span><a id="line.266"> },</a> |
| <span class="sourceLineNo">267</span><a id="line.267"> responses = {</a> |
| <span class="sourceLineNo">268</span><a id="line.268"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">269</span><a id="line.269"> description = "If role deletion was successful"</a> |
| <span class="sourceLineNo">270</span><a id="line.270"> ),</a> |
| <span class="sourceLineNo">271</span><a id="line.271"> @ApiResponse( responseCode = "404", description = "Role does not exist",</a> |
| <span class="sourceLineNo">272</span><a id="line.272"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">273</span><a id="line.273"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for deletion.",</a> |
| <span class="sourceLineNo">274</span><a id="line.274"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">275</span><a id="line.275"> }</a> |
| <span class="sourceLineNo">276</span><a id="line.276"> )</a> |
| <span class="sourceLineNo">277</span><a id="line.277"> Response removeTemplatedRole( @PathParam( "templateId" ) String templateId,</a> |
| <span class="sourceLineNo">278</span><a id="line.278"> @PathParam( "resource" ) String resource )</a> |
| <span class="sourceLineNo">279</span><a id="line.279"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">280</span><a id="line.280"></a> |
| <span class="sourceLineNo">281</span><a id="line.281"></a> |
| <span class="sourceLineNo">282</span><a id="line.282"></a> |
| <span class="sourceLineNo">283</span><a id="line.283"> /**</a> |
| <span class="sourceLineNo">284</span><a id="line.284"> * Assigns the templated role indicated by the templateId</a> |
| <span class="sourceLineNo">285</span><a id="line.285"> *</a> |
| <span class="sourceLineNo">286</span><a id="line.286"> * fails if the templated role has not been created</a> |
| <span class="sourceLineNo">287</span><a id="line.287"> *</a> |
| <span class="sourceLineNo">288</span><a id="line.288"> * @param templateId</a> |
| <span class="sourceLineNo">289</span><a id="line.289"> * @param resource</a> |
| <span class="sourceLineNo">290</span><a id="line.290"> * @param userId</a> |
| <span class="sourceLineNo">291</span><a id="line.291"> */</a> |
| <span class="sourceLineNo">292</span><a id="line.292"> @Path( "templates/{templateId}/{resource}/user/{userId}" )</a> |
| <span class="sourceLineNo">293</span><a id="line.293"> @PUT</a> |
| <span class="sourceLineNo">294</span><a id="line.294"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">295</span><a id="line.295"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">296</span><a id="line.296"> @Operation( summary = "Assigns a template role instance to a given user",</a> |
| <span class="sourceLineNo">297</span><a id="line.297"> security = {</a> |
| <span class="sourceLineNo">298</span><a id="line.298"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">299</span><a id="line.299"> },</a> |
| <span class="sourceLineNo">300</span><a id="line.300"> responses = {</a> |
| <span class="sourceLineNo">301</span><a id="line.301"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">302</span><a id="line.302"> description = "If the role instance was assigned"</a> |
| <span class="sourceLineNo">303</span><a id="line.303"> ),</a> |
| <span class="sourceLineNo">304</span><a id="line.304"> @ApiResponse( responseCode = "404", description = "Role instance does not exist",</a> |
| <span class="sourceLineNo">305</span><a id="line.305"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">306</span><a id="line.306"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role assignment.",</a> |
| <span class="sourceLineNo">307</span><a id="line.307"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">308</span><a id="line.308"> }</a> |
| <span class="sourceLineNo">309</span><a id="line.309"> )</a> |
| <span class="sourceLineNo">310</span><a id="line.310"> RoleInfo assignTemplatedRole( @PathParam( "templateId" ) String templateId,</a> |
| <span class="sourceLineNo">311</span><a id="line.311"> @PathParam( "resource" ) String resource,</a> |
| <span class="sourceLineNo">312</span><a id="line.312"> @PathParam( "userId" ) String userId )</a> |
| <span class="sourceLineNo">313</span><a id="line.313"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">314</span><a id="line.314"></a> |
| <span class="sourceLineNo">315</span><a id="line.315"> /**</a> |
| <span class="sourceLineNo">316</span><a id="line.316"> * Assigns the role indicated by the roleId to the given principal</a> |
| <span class="sourceLineNo">317</span><a id="line.317"> *</a> |
| <span class="sourceLineNo">318</span><a id="line.318"> * @param roleId</a> |
| <span class="sourceLineNo">319</span><a id="line.319"> * @param userId</a> |
| <span class="sourceLineNo">320</span><a id="line.320"> */</a> |
| <span class="sourceLineNo">321</span><a id="line.321"> @Path( "{roleId}/user/{userId}" )</a> |
| <span class="sourceLineNo">322</span><a id="line.322"> @PUT</a> |
| <span class="sourceLineNo">323</span><a id="line.323"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">324</span><a id="line.324"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">325</span><a id="line.325"> @Operation( summary = "Assigns a role to a given user",</a> |
| <span class="sourceLineNo">326</span><a id="line.326"> security = {</a> |
| <span class="sourceLineNo">327</span><a id="line.327"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">328</span><a id="line.328"> },</a> |
| <span class="sourceLineNo">329</span><a id="line.329"> responses = {</a> |
| <span class="sourceLineNo">330</span><a id="line.330"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">331</span><a id="line.331"> description = "If the role was assigned"</a> |
| <span class="sourceLineNo">332</span><a id="line.332"> ),</a> |
| <span class="sourceLineNo">333</span><a id="line.333"> @ApiResponse( responseCode = "404", description = "Role does not exist",</a> |
| <span class="sourceLineNo">334</span><a id="line.334"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">335</span><a id="line.335"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role assignment.",</a> |
| <span class="sourceLineNo">336</span><a id="line.336"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">337</span><a id="line.337"> }</a> |
| <span class="sourceLineNo">338</span><a id="line.338"> )</a> |
| <span class="sourceLineNo">339</span><a id="line.339"> RoleInfo assignRole( @PathParam( "roleId" ) String roleId, @PathParam( "userId" ) String userId )</a> |
| <span class="sourceLineNo">340</span><a id="line.340"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">341</span><a id="line.341"></a> |
| <span class="sourceLineNo">342</span><a id="line.342"> /**</a> |
| <span class="sourceLineNo">343</span><a id="line.343"> * Deletes the assignment of a role to a user.</a> |
| <span class="sourceLineNo">344</span><a id="line.344"> *</a> |
| <span class="sourceLineNo">345</span><a id="line.345"> * @param roleId the role id</a> |
| <span class="sourceLineNo">346</span><a id="line.346"> * @param userId the user id</a> |
| <span class="sourceLineNo">347</span><a id="line.347"> * @throws RedbackServiceException</a> |
| <span class="sourceLineNo">348</span><a id="line.348"> */</a> |
| <span class="sourceLineNo">349</span><a id="line.349"> @Path( "{roleId}/user/{userId}" )</a> |
| <span class="sourceLineNo">350</span><a id="line.350"> @DELETE</a> |
| <span class="sourceLineNo">351</span><a id="line.351"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">352</span><a id="line.352"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">353</span><a id="line.353"> @Operation( summary = "Removes a role assignment for the given role and user",</a> |
| <span class="sourceLineNo">354</span><a id="line.354"> security = {</a> |
| <span class="sourceLineNo">355</span><a id="line.355"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">356</span><a id="line.356"> },</a> |
| <span class="sourceLineNo">357</span><a id="line.357"> responses = {</a> |
| <span class="sourceLineNo">358</span><a id="line.358"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">359</span><a id="line.359"> description = "If the role assignment was removed"</a> |
| <span class="sourceLineNo">360</span><a id="line.360"> ),</a> |
| <span class="sourceLineNo">361</span><a id="line.361"> @ApiResponse( responseCode = "404", description = "Role instance does not exist",</a> |
| <span class="sourceLineNo">362</span><a id="line.362"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">363</span><a id="line.363"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role assignment.",</a> |
| <span class="sourceLineNo">364</span><a id="line.364"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">365</span><a id="line.365"> }</a> |
| <span class="sourceLineNo">366</span><a id="line.366"> )</a> |
| <span class="sourceLineNo">367</span><a id="line.367"> RoleInfo deleteRoleAssignment( @PathParam( "roleId" ) String roleId, @PathParam( "userId" ) String userId )</a> |
| <span class="sourceLineNo">368</span><a id="line.368"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">369</span><a id="line.369"></a> |
| <span class="sourceLineNo">370</span><a id="line.370"> /**</a> |
| <span class="sourceLineNo">371</span><a id="line.371"> * This returns the list of assigned users to a given role. The flag "recurse" is a query parameter.</a> |
| <span class="sourceLineNo">372</span><a id="line.372"> * If the query parameter exists and is not set to 'false', or '0', it will recurse all parent roles and return a list of users</a> |
| <span class="sourceLineNo">373</span><a id="line.373"> * assigned to the current role and the parent roles up to the root.</a> |
| <span class="sourceLineNo">374</span><a id="line.374"> * If the query parameter does not exist or is set to 'false' or '0', it will return only the users assigned directly</a> |
| <span class="sourceLineNo">375</span><a id="line.375"> * to the given role.</a> |
| <span class="sourceLineNo">376</span><a id="line.376"> *</a> |
| <span class="sourceLineNo">377</span><a id="line.377"> * @param roleId the role identifier, for which the assigned users are returned</a> |
| <span class="sourceLineNo">378</span><a id="line.378"> * @param recurse if the parameter does not exist or is set to 'false' or '0', only directly assigned users are returned.</a> |
| <span class="sourceLineNo">379</span><a id="line.379"> * If the parameter value is set to 'parentsOnly', the users assigned to all parent roles up to the root excluding the</a> |
| <span class="sourceLineNo">380</span><a id="line.380"> * given role are returned.</a> |
| <span class="sourceLineNo">381</span><a id="line.381"> * Otherwise all users assigned to the given role and all parent roles up to the root are returned.</a> |
| <span class="sourceLineNo">382</span><a id="line.382"> * @param searchTerm the substring query term to search for in the user ids and names</a> |
| <span class="sourceLineNo">383</span><a id="line.383"> * @param offset the offset index in the user list for paging</a> |
| <span class="sourceLineNo">384</span><a id="line.384"> * @param limit the maximum number of users returned</a> |
| <span class="sourceLineNo">385</span><a id="line.385"> * @param orderBy the order attributes for ordering</a> |
| <span class="sourceLineNo">386</span><a id="line.386"> * @param order the order direction 'asc' (ascending), or 'desc' (descending)</a> |
| <span class="sourceLineNo">387</span><a id="line.387"> * @return the list of user objects</a> |
| <span class="sourceLineNo">388</span><a id="line.388"> * @throws RedbackServiceException</a> |
| <span class="sourceLineNo">389</span><a id="line.389"> */</a> |
| <span class="sourceLineNo">390</span><a id="line.390"> @Path("{roleId}/user")</a> |
| <span class="sourceLineNo">391</span><a id="line.391"> @GET</a> |
| <span class="sourceLineNo">392</span><a id="line.392"> @Produces({APPLICATION_JSON})</a> |
| <span class="sourceLineNo">393</span><a id="line.393"> @RedbackAuthorization(permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION)</a> |
| <span class="sourceLineNo">394</span><a id="line.394"> @Operation( summary = "Returns the users assigned to the given role",</a> |
| <span class="sourceLineNo">395</span><a id="line.395"> parameters = {</a> |
| <span class="sourceLineNo">396</span><a id="line.396"> @Parameter(name = "q", description = "Search term"),</a> |
| <span class="sourceLineNo">397</span><a id="line.397"> @Parameter(name = "offset", description = "The offset of the first element returned"),</a> |
| <span class="sourceLineNo">398</span><a id="line.398"> @Parameter(name = "limit", description = "Maximum number of items to return in the response"),</a> |
| <span class="sourceLineNo">399</span><a id="line.399"> @Parameter(name = "orderBy", description = "List of attribute used for sorting (user_id, fullName, email, created"),</a> |
| <span class="sourceLineNo">400</span><a id="line.400"> @Parameter(name = "order", description = "The sort order. Either ascending (asc) or descending (desc)"),</a> |
| <span class="sourceLineNo">401</span><a id="line.401"> @Parameter(name = "recurse", description = "If not present, or set to 'false' or '0', only users assigned directly to this role are returned."+</a> |
| <span class="sourceLineNo">402</span><a id="line.402"> " If present and set to 'parentsOnly', the list of users assigned to all parents of the given role up to the root."+</a> |
| <span class="sourceLineNo">403</span><a id="line.403"> " If present and set to any other value than 'parentsOnly', 'false' or '0', the users assigned to this role or any parent role in the hierarchy"+</a> |
| <span class="sourceLineNo">404</span><a id="line.404"> " up to the root are returned.")</a> |
| <span class="sourceLineNo">405</span><a id="line.405"> },</a> |
| <span class="sourceLineNo">406</span><a id="line.406"> security = {</a> |
| <span class="sourceLineNo">407</span><a id="line.407"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">408</span><a id="line.408"> },</a> |
| <span class="sourceLineNo">409</span><a id="line.409"> responses = {</a> |
| <span class="sourceLineNo">410</span><a id="line.410"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">411</span><a id="line.411"> description = "If the users could be retrieved"</a> |
| <span class="sourceLineNo">412</span><a id="line.412"> ),</a> |
| <span class="sourceLineNo">413</span><a id="line.413"> @ApiResponse( responseCode = "404", description = "Role instance does not exist",</a> |
| <span class="sourceLineNo">414</span><a id="line.414"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">415</span><a id="line.415"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role assignment.",</a> |
| <span class="sourceLineNo">416</span><a id="line.416"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">417</span><a id="line.417"> }</a> |
| <span class="sourceLineNo">418</span><a id="line.418"> )</a> |
| <span class="sourceLineNo">419</span><a id="line.419"> PagedResult<UserInfo> getRoleUsers(@PathParam( "roleId" ) String roleId,</a> |
| <span class="sourceLineNo">420</span><a id="line.420"> @QueryParam("recurse") String recurse,</a> |
| <span class="sourceLineNo">421</span><a id="line.421"> @QueryParam("q") @DefaultValue( "" ) String searchTerm,</a> |
| <span class="sourceLineNo">422</span><a id="line.422"> @QueryParam( "offset" ) @DefaultValue( "0" ) Integer offset,</a> |
| <span class="sourceLineNo">423</span><a id="line.423"> @QueryParam( "limit" ) @DefaultValue( value = DEFAULT_PAGE_LIMIT ) Integer limit,</a> |
| <span class="sourceLineNo">424</span><a id="line.424"> @QueryParam( "orderBy") @DefaultValue( "id" ) List<String> orderBy,</a> |
| <span class="sourceLineNo">425</span><a id="line.425"> @QueryParam("order") @DefaultValue( "asc" ) String order</a> |
| <span class="sourceLineNo">426</span><a id="line.426"> ) throws RedbackServiceException;</a> |
| <span class="sourceLineNo">427</span><a id="line.427"></a> |
| <span class="sourceLineNo">428</span><a id="line.428"></a> |
| <span class="sourceLineNo">429</span><a id="line.429"> @Path("{roleId}/unassigned")</a> |
| <span class="sourceLineNo">430</span><a id="line.430"> @GET</a> |
| <span class="sourceLineNo">431</span><a id="line.431"> @Produces({APPLICATION_JSON})</a> |
| <span class="sourceLineNo">432</span><a id="line.432"> @RedbackAuthorization(permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION)</a> |
| <span class="sourceLineNo">433</span><a id="line.433"> @Operation( summary = "Returns the users not assigned to the given role",</a> |
| <span class="sourceLineNo">434</span><a id="line.434"> parameters = {</a> |
| <span class="sourceLineNo">435</span><a id="line.435"> @Parameter(name = "q", description = "Search term"),</a> |
| <span class="sourceLineNo">436</span><a id="line.436"> @Parameter(name = "offset", description = "The offset of the first element returned"),</a> |
| <span class="sourceLineNo">437</span><a id="line.437"> @Parameter(name = "limit", description = "Maximum number of items to return in the response"),</a> |
| <span class="sourceLineNo">438</span><a id="line.438"> @Parameter(name = "orderBy", description = "List of attribute used for sorting (user_id, fullName, email, created"),</a> |
| <span class="sourceLineNo">439</span><a id="line.439"> @Parameter(name = "order", description = "The sort order. Either ascending (asc) or descending (desc)"),</a> |
| <span class="sourceLineNo">440</span><a id="line.440"> @Parameter(name = "recurse", description = "If not present, or set to 'false' or '0', only users assigned directly to this role are returned."+</a> |
| <span class="sourceLineNo">441</span><a id="line.441"> " If present and set to 'parentsOnly', the list of users assigned to all parents of the given role up to the root."+</a> |
| <span class="sourceLineNo">442</span><a id="line.442"> " If present and set to any other value than 'parentsOnly', 'false' or '0', the users assigned to this role or any parent role in the hierarchy"+</a> |
| <span class="sourceLineNo">443</span><a id="line.443"> " up to the root are returned.")</a> |
| <span class="sourceLineNo">444</span><a id="line.444"> },</a> |
| <span class="sourceLineNo">445</span><a id="line.445"> security = {</a> |
| <span class="sourceLineNo">446</span><a id="line.446"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">447</span><a id="line.447"> },</a> |
| <span class="sourceLineNo">448</span><a id="line.448"> responses = {</a> |
| <span class="sourceLineNo">449</span><a id="line.449"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">450</span><a id="line.450"> description = "If the users could be retrieved"</a> |
| <span class="sourceLineNo">451</span><a id="line.451"> ),</a> |
| <span class="sourceLineNo">452</span><a id="line.452"> @ApiResponse( responseCode = "404", description = "Role instance does not exist",</a> |
| <span class="sourceLineNo">453</span><a id="line.453"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">454</span><a id="line.454"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role assignment.",</a> |
| <span class="sourceLineNo">455</span><a id="line.455"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">456</span><a id="line.456"> }</a> |
| <span class="sourceLineNo">457</span><a id="line.457"> )</a> |
| <span class="sourceLineNo">458</span><a id="line.458"> PagedResult<UserInfo> getUnassignedUsers(@PathParam( "roleId" ) String roleId,</a> |
| <span class="sourceLineNo">459</span><a id="line.459"> @QueryParam("recurse") String recurse,</a> |
| <span class="sourceLineNo">460</span><a id="line.460"> @QueryParam("q") @DefaultValue( "" ) String searchTerm,</a> |
| <span class="sourceLineNo">461</span><a id="line.461"> @QueryParam( "offset" ) @DefaultValue( "0" ) Integer offset,</a> |
| <span class="sourceLineNo">462</span><a id="line.462"> @QueryParam( "limit" ) @DefaultValue( value = DEFAULT_PAGE_LIMIT ) Integer limit,</a> |
| <span class="sourceLineNo">463</span><a id="line.463"> @QueryParam( "orderBy") @DefaultValue( "id" ) List<String> orderBy,</a> |
| <span class="sourceLineNo">464</span><a id="line.464"> @QueryParam("order") @DefaultValue( "asc" ) String order</a> |
| <span class="sourceLineNo">465</span><a id="line.465"> ) throws RedbackServiceException;</a> |
| <span class="sourceLineNo">466</span><a id="line.466"></a> |
| <span class="sourceLineNo">467</span><a id="line.467"></a> |
| <span class="sourceLineNo">468</span><a id="line.468"> /**</a> |
| <span class="sourceLineNo">469</span><a id="line.469"> * Updates a role. Attributes that are empty or null will be ignored.</a> |
| <span class="sourceLineNo">470</span><a id="line.470"> *</a> |
| <span class="sourceLineNo">471</span><a id="line.471"> * @since 3.0</a> |
| <span class="sourceLineNo">472</span><a id="line.472"> */</a> |
| <span class="sourceLineNo">473</span><a id="line.473"> @Path( "{roleId}" )</a> |
| <span class="sourceLineNo">474</span><a id="line.474"> @PATCH</a> |
| <span class="sourceLineNo">475</span><a id="line.475"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">476</span><a id="line.476"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">477</span><a id="line.477"> @Operation( summary = "Creates or updates the given role",</a> |
| <span class="sourceLineNo">478</span><a id="line.478"> security = {</a> |
| <span class="sourceLineNo">479</span><a id="line.479"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">480</span><a id="line.480"> },</a> |
| <span class="sourceLineNo">481</span><a id="line.481"> responses = {</a> |
| <span class="sourceLineNo">482</span><a id="line.482"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">483</span><a id="line.483"> description = "If the update was successful"</a> |
| <span class="sourceLineNo">484</span><a id="line.484"> ),</a> |
| <span class="sourceLineNo">485</span><a id="line.485"> @ApiResponse( responseCode = "404", description = "Role does not exist",</a> |
| <span class="sourceLineNo">486</span><a id="line.486"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">487</span><a id="line.487"> @ApiResponse( responseCode = "422", description = "Role id does not match the id of the request path",</a> |
| <span class="sourceLineNo">488</span><a id="line.488"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) ),</a> |
| <span class="sourceLineNo">489</span><a id="line.489"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role assignment.",</a> |
| <span class="sourceLineNo">490</span><a id="line.490"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">491</span><a id="line.491"> }</a> |
| <span class="sourceLineNo">492</span><a id="line.492"> )</a> |
| <span class="sourceLineNo">493</span><a id="line.493"> RoleInfo updateRole( @PathParam("roleId") String roleId, Role role )</a> |
| <span class="sourceLineNo">494</span><a id="line.494"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">495</span><a id="line.495"></a> |
| <span class="sourceLineNo">496</span><a id="line.496"> @Path( "templates" )</a> |
| <span class="sourceLineNo">497</span><a id="line.497"> @GET</a> |
| <span class="sourceLineNo">498</span><a id="line.498"> @Produces( { APPLICATION_JSON } )</a> |
| <span class="sourceLineNo">499</span><a id="line.499"> @RedbackAuthorization( permissions = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">500</span><a id="line.500"> @Operation( summary = "Returns all role templates",</a> |
| <span class="sourceLineNo">501</span><a id="line.501"> security = {</a> |
| <span class="sourceLineNo">502</span><a id="line.502"> @SecurityRequirement( name = RedbackRoleConstants.USER_MANAGEMENT_RBAC_ADMIN_OPERATION )</a> |
| <span class="sourceLineNo">503</span><a id="line.503"> },</a> |
| <span class="sourceLineNo">504</span><a id="line.504"> responses = {</a> |
| <span class="sourceLineNo">505</span><a id="line.505"> @ApiResponse( responseCode = "200",</a> |
| <span class="sourceLineNo">506</span><a id="line.506"> description = "If the list could be retrieved"</a> |
| <span class="sourceLineNo">507</span><a id="line.507"> ),</a> |
| <span class="sourceLineNo">508</span><a id="line.508"> @ApiResponse( responseCode = "403", description = "The authenticated user has not the permission for role assignment.",</a> |
| <span class="sourceLineNo">509</span><a id="line.509"> content = @Content(mediaType = APPLICATION_JSON, schema = @Schema(implementation = RedbackRestError.class )) )</a> |
| <span class="sourceLineNo">510</span><a id="line.510"> }</a> |
| <span class="sourceLineNo">511</span><a id="line.511"> )</a> |
| <span class="sourceLineNo">512</span><a id="line.512"> List<RoleTemplate> getTemplates( ) throws RedbackServiceException;</a> |
| <span class="sourceLineNo">513</span><a id="line.513"></a> |
| <span class="sourceLineNo">514</span><a id="line.514">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
