blob: 5520dc6cd5bb2815eb57b5111f53b78c69ccc172 [file] [log] [blame]
<!doctype html>
<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ -->
<!--[if lt IE 7 ]> <html class="no-js ie6" lang="en"> <![endif]-->
<!--[if IE 7 ]> <html class="no-js ie7" lang="en"> <![endif]-->
<!--[if IE 8 ]> <html class="no-js ie8" lang="en"> <![endif]-->
<!--[if (gte IE 9)|!(IE)]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame
Remove this if you use the .htaccess -->
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>RoleManagementService</title>
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- CSS: implied media="all" -->
<link rel="stylesheet" href="css/style.css?v=2">
<link rel="stylesheet" href="css/prettify.css">
<!-- All JavaScript at the bottom, except for Modernizr which enables HTML5 elements & feature detects -->
<script src="js/libs/modernizr-1.7.min.js"></script>
</head>
<body class="home">
<div class="container">
<header>
<div id="header" class="column first last span-20">
<div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">RoleManagementService</a></div>
<div id="primary" class="column span-18 append-1 prepend-1 first last">
<ul class="navigation">
<li id="nav-rest"><a href="rest.html">REST</a></li>
<li id="nav-data"><a href="model.html">Data Model</a></li>
</ul>
</div>
<div>
<ul class="xbreadcrumbs" id="breadcrumbs">
<li>
<a href="index.html" class="home">Home</a> &gt;
</li>
<li>
<a href="rest.html">REST</a> &gt;
<ul>
<li><a href="model.html">Data Model</a></li>
<li><a href="rest.html">REST</a></li>
</ul>
</li>
<li class="current">
<a href="resource_RoleManagementService.html">RoleManagementService</a>
<ul>
<li><a href="resource_UtilServices.html">UtilServices</a></li>
<li><a href="resource_UserService.html">UserService</a></li>
<li><a href="resource_LoginService.html">LoginService</a></li>
<li><a href="resource_RoleManagementService.html">RoleManagementService</a></li>
<li><a href="resource_LdapGroupMappingService.html">LdapGroupMappingService</a></li>
<li><a href="resource_PasswordService.html">PasswordService</a></li>
</ul>
</li>
</ul>
</div>
</div>
</header>
<div id="main" class="column first last span-20">
<h1>RoleManagementService</h1>
<p></p>
<p>The following resources are part of this group:</p>
<ul>
<li><a href="#path__roleManagementService_allRoles.html">/roleManagementService/allRoles</a></li>
<li><a href="#path__roleManagementService_assignRole.html">/roleManagementService/assignRole</a></li>
<li><a href="#path__roleManagementService_assignRoleByName.html">/roleManagementService/assignRoleByName</a></li>
<li><a href="#path__roleManagementService_assignTemplatedRole.html">/roleManagementService/assignTemplatedRole</a></li>
<li><a href="#path__roleManagementService_createTemplatedRole.html">/roleManagementService/createTemplatedRole</a></li>
<li><a href="#path__roleManagementService_detailledAllRoles.html">/roleManagementService/detailledAllRoles</a></li>
<li><a href="#path__roleManagementService_removeTemplatedRole.html">/roleManagementService/removeTemplatedRole</a></li>
<li><a href="#path__roleManagementService_roleExists.html">/roleManagementService/roleExists</a></li>
<li><a href="#path__roleManagementService_templatedRoleExists.html">/roleManagementService/templatedRoleExists</a></li>
<li><a href="#path__roleManagementService_unassignRole.html">/roleManagementService/unassignRole</a></li>
<li><a href="#path__roleManagementService_unassignRoleByName.html">/roleManagementService/unassignRoleByName</a></li>
<li><a href="#path__roleManagementService_updateRole.html">/roleManagementService/updateRole</a></li>
<li><a href="#path__roleManagementService_updateRoleDescription.html">/roleManagementService/updateRoleDescription</a></li>
<li><a href="#path__roleManagementService_updateRoleUsers.html">/roleManagementService/updateRoleUsers</a></li>
<li><a href="#path__roleManagementService_updateUserRoles.html">/roleManagementService/updateUserRoles</a></li>
<li><a href="#path__roleManagementService_verifyTemplatedRole.html">/roleManagementService/verifyTemplatedRole</a></li>
<li><a href="#path__roleManagementService_getApplicationRoles_-username-.html">/roleManagementService/getApplicationRoles/{username}</a></li>
<li><a href="#path__roleManagementService_getApplications_-username-.html">/roleManagementService/getApplications/{username}</a></li>
<li><a href="#path__roleManagementService_getEffectivelyAssignedRoles_-username-.html">/roleManagementService/getEffectivelyAssignedRoles/{username}</a></li>
<li><a href="#path__roleManagementService_getRole_-roleName-.html">/roleManagementService/getRole/{roleName}</a></li>
</ul>
<a name="path__roleManagementService_allRoles.html"></a>
<h1>/roleManagementService/allRoles</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/allRoles">/redbackServices/roleManagementService/allRoles</a></p>
<p class="note">Available Since: 2.0</p>
<a name="GET"></a>
<h2>GET</h2>
<p class="note">Available Since: 2.0</p>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_assignRole.html"></a>
<h1>/roleManagementService/assignRole</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/assignRole">/redbackServices/roleManagementService/assignRole</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
Assigns the role indicated by the roleId to the given principal
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>roleId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>principal</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_assignRoleByName.html"></a>
<h1>/roleManagementService/assignRoleByName</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/assignRoleByName">/redbackServices/roleManagementService/assignRoleByName</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
Assigns the role indicated by the roleName to the given principal
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>roleName</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>principal</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_assignTemplatedRole.html"></a>
<h1>/roleManagementService/assignTemplatedRole</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/assignTemplatedRole">/redbackServices/roleManagementService/assignTemplatedRole</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
Assigns the templated role indicated by the templateId
<p/>
fails if the templated role has not been created
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>templateId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>resource</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>principal</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_createTemplatedRole.html"></a>
<h1>/roleManagementService/createTemplatedRole</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/createTemplatedRole">/redbackServices/roleManagementService/createTemplatedRole</a></p>
<a name="GET"></a>
<h2>GET</h2>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>templateId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>resource</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_detailledAllRoles.html"></a>
<h1>/roleManagementService/detailledAllRoles</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/detailledAllRoles">/redbackServices/roleManagementService/detailledAllRoles</a></p>
<p class="note">Available Since: 2.0</p>
<a name="GET"></a>
<h2>GET</h2>
<p class="note">Available Since: 2.0</p>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_removeTemplatedRole.html"></a>
<h1>/roleManagementService/removeTemplatedRole</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/removeTemplatedRole">/redbackServices/roleManagementService/removeTemplatedRole</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
removes a role corresponding to the role Id that was manufactured with the given resource
<p/>
it also removes any user assignments for that role
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>templateId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>resource</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_roleExists.html"></a>
<h1>/roleManagementService/roleExists</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/roleExists">/redbackServices/roleManagementService/roleExists</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
true of a role exists with the given roleId
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>roleId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_templatedRoleExists.html"></a>
<h1>/roleManagementService/templatedRoleExists</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/templatedRoleExists">/redbackServices/roleManagementService/templatedRoleExists</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
true of a role exists with the given roleId
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>templateId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>resource</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_unassignRole.html"></a>
<h1>/roleManagementService/unassignRole</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/unassignRole">/redbackServices/roleManagementService/unassignRole</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
Unassigns the role indicated by the role id from the given principal
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>roleId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>principal</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_unassignRoleByName.html"></a>
<h1>/roleManagementService/unassignRoleByName</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/unassignRoleByName">/redbackServices/roleManagementService/unassignRoleByName</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
Unassigns the role indicated by the role name from the given principal
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>roleName</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>principal</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_updateRole.html"></a>
<h1>/roleManagementService/updateRole</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/updateRole">/redbackServices/roleManagementService/updateRole</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
allows for a role coming from a template to be renamed effectively swapping out the bits of it that
were labeled with the oldResource with the newResource
<p/>
it also manages any user assignments for that role
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>templateId</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>oldResource</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>newResource</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_updateRoleDescription.html"></a>
<h1>/roleManagementService/updateRoleDescription</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/updateRoleDescription">/redbackServices/roleManagementService/updateRoleDescription</a></p>
<p class="note">Available Since: 2.0</p>
<a name="GET"></a>
<h2>GET</h2>
<p class="note">Available Since: 2.0</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>roleName</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>roleDescription</td>
<td>
(no documentation provided)
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_updateRoleUsers.html"></a>
<h1>/roleManagementService/updateRoleUsers</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/updateRoleUsers">/redbackServices/roleManagementService/updateRoleUsers</a></p>
<p class="note">Available Since: 2.0</p>
<a name="POST"></a>
<h2>POST</h2>
<p class="note">Available Since: 2.0</p>
<p>
update users assigned to a role
</p>
<h3>Request Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td><a href="el_ns0_role.html">role</a></td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_updateUserRoles.html"></a>
<h1>/roleManagementService/updateUserRoles</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/updateUserRoles">/redbackServices/roleManagementService/updateUserRoles</a></p>
<p class="note">Available Since: 2.0</p>
<a name="POST"></a>
<h2>POST</h2>
<p class="note">Available Since: 2.0</p>
<p>
update roles assigned to a user
</p>
<h3>Request Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td><a href="el_ns0_user.html">user</a></td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_verifyTemplatedRole.html"></a>
<h1>/roleManagementService/verifyTemplatedRole</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/verifyTemplatedRole">/redbackServices/roleManagementService/verifyTemplatedRole</a></p>
<a name="GET"></a>
<h2>GET</h2>
<p>
Check a role template is complete in the RBAC store.
</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>templateId</td>
<td>
the templated role
</td>
<td>query</td>
<td></td>
</tr>
<tr>
<td>resource</td>
<td>
the resource to verify
</td>
<td>query</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_getApplicationRoles_-username-.html"></a>
<h1>/roleManagementService/getApplicationRoles/{username}</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/getApplicationRoles/{username}">/redbackServices/roleManagementService/getApplicationRoles/{username}</a></p>
<p class="note">Available Since: 2.0</p>
<a name="GET"></a>
<h2>GET</h2>
<p class="note">Available Since: 2.0</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>username</td>
<td>
(no documentation provided)
</td>
<td>path</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_getApplications_-username-.html"></a>
<h1>/roleManagementService/getApplications/{username}</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/getApplications/{username}">/redbackServices/roleManagementService/getApplications/{username}</a></p>
<p class="note">Available Since: 2.0</p>
<a name="GET"></a>
<h2>GET</h2>
<p class="note">Available Since: 2.0</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>username</td>
<td>
(no documentation provided)
</td>
<td>path</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_getEffectivelyAssignedRoles_-username-.html"></a>
<h1>/roleManagementService/getEffectivelyAssignedRoles/{username}</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/getEffectivelyAssignedRoles/{username}">/redbackServices/roleManagementService/getEffectivelyAssignedRoles/{username}</a></p>
<p class="note">Available Since: 1.4</p>
<a name="GET"></a>
<h2>GET</h2>
<p class="note">Available Since: 1.4</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>username</td>
<td>
(no documentation provided)
</td>
<td>path</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td>(custom)</td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<a name="path__roleManagementService_getRole_-roleName-.html"></a>
<h1>/roleManagementService/getRole/{roleName}</h1>
<p class="note">Mount Point: <a href="../redbackServices/roleManagementService/getRole/{roleName}">/redbackServices/roleManagementService/getRole/{roleName}</a></p>
<p class="note">Available Since: 2.0</p>
<a name="GET"></a>
<h2>GET</h2>
<p class="note">Available Since: 2.0</p>
<h3>Parameters</h3>
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default</th>
</tr>
<tr>
<td>roleName</td>
<td>
(no documentation provided)
</td>
<td>path</td>
<td></td>
</tr>
</table>
<h3>Response Body</h3>
<table>
<tr>
<td align="right">element:</td>
<td><a href="el_ns0_role.html">role</a></td>
</tr>
<tr>
<td align="right">media types:</td>
<td>application/xml<br/>text/plain<br/>application/json</td>
</tr>
</table>
<p>(no documentation provided)</p>
<div class="clear" />
</div>
<footer>
<div id="footer">
Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>.
</div>
</footer>
</div> <!--! end of #container -->
<!-- JavaScript at the bottom for fast page loading -->
<!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if necessary -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.js"></script>
<script>window.jQuery || document.write("<script src='js/libs/jquery-1.5.1.min.js'>\x3C/script>")</script>
<!--manage the navigation menu-->
<script src="js/libs/xbreadcrumbs.js"></script>
<script>
$(function() {
$('#breadcrumbs').xBreadcrumbs();
});
</script>
<!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
<script src="js/libs/prettify/prettify.js"></script>
<script>
$(function() {
prettyPrint();
});
</script>
<!--[if lt IE 7 ]>
<script src="js/libs/dd_belatedpng.js"></script>
<script>DD_belatedPNG.fix("img, .png_bg"); // Fix any <img> or .png_bg bg-images. Also, please read goo.gl/mZiyb </script>
<![endif]-->
</body>
</html>