| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> |
| |
| <title>Apache Archiva Redback REST API: RoleManagementService</title> |
| |
| <!-- Mobile viewport optimized: j.mp/bplateviewport --> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <!-- Bootstrap core CSS --> |
| <!-- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> --> |
| |
| <!--custom css for these pages--> |
| <link rel="stylesheet" href="css/enunciate.css"> |
| |
| <link href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.css" type="text/css"> |
| |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| </head> |
| |
| <body class="home"> |
| <div class="container"> |
| <header> |
| |
| <div id="header" class="column first last span-20"> |
| <div id="site-name" class="column span-18 append-1 prepend-1 first last"><a href="index.html">Apache Archiva Redback REST API: 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="resources.html">REST</a></li> |
| <li id="nav-data"><a href="data.html">Data Model</a></li> |
| </ul> |
| </div> |
| <div> |
| <ul class="xbreadcrumbs" id="breadcrumbs"> |
| <li> |
| <a href="index.html" class="home">Home</a> > |
| |
| </li> |
| <li> |
| <a href="resources.html">Resources</a> > |
| |
| </li> |
| <li class="current"> |
| <a href="resource_RoleManagementService.html">RoleManagementService</a> |
| |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!--<nav class="navbar navbar-inverse navbar-fixed-top"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="index.html">Apache Archiva Redback REST API: RoleManagementService</a> |
| </div> |
| <div id="navbar" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav navbar-right"> |
| <li><a href="resources.html">Resources</a></li> |
| <li><a href="data.html">Data Types</a></li> |
| <li><a href="downloads.html">Files and Libraries</a></li> |
| </ul> |
| </div> |
| </div> |
| </nav>--> |
| </header> |
| <div id="main" class="column first last span-20"> |
| |
| <h1 class="page-header">RoleManagementService <small>Resource</small></h1> |
| |
| <p></p> |
| <ul> |
| <li><a href="#resource_RoleManagementService_getAllRoles_GET">./redbackServices/roleManagementService/allRoles</a></li> |
| <li><a href="#resource_RoleManagementService_assignRole_GET">./redbackServices/roleManagementService/assignRole</a></li> |
| <li><a href="#resource_RoleManagementService_assignRoleByName_GET">./redbackServices/roleManagementService/assignRoleByName</a></li> |
| <li><a href="#resource_RoleManagementService_assignTemplatedRole_GET">./redbackServices/roleManagementService/assignTemplatedRole</a></li> |
| <li><a href="#resource_RoleManagementService_createTemplatedRole_GET">./redbackServices/roleManagementService/createTemplatedRole</a></li> |
| <li><a href="#resource_RoleManagementService_getDetailedAllRoles_GET">./redbackServices/roleManagementService/detailledAllRoles</a></li> |
| <li><a href="#resource_RoleManagementService_getApplicationRoles_GET">./redbackServices/roleManagementService/getApplicationRoles/{username}</a></li> |
| <li><a href="#resource_RoleManagementService_getApplications_GET">./redbackServices/roleManagementService/getApplications/{username}</a></li> |
| <li><a href="#resource_RoleManagementService_getEffectivelyAssignedRoles_GET">./redbackServices/roleManagementService/getEffectivelyAssignedRoles/{username}</a></li> |
| <li><a href="#resource_RoleManagementService_getRole_GET">./redbackServices/roleManagementService/getRole/{roleName}</a></li> |
| <li><a href="#resource_RoleManagementService_removeTemplatedRole_GET">./redbackServices/roleManagementService/removeTemplatedRole</a></li> |
| <li><a href="#resource_RoleManagementService_roleExists_GET">./redbackServices/roleManagementService/roleExists</a></li> |
| <li><a href="#resource_RoleManagementService_templatedRoleExists_GET">./redbackServices/roleManagementService/templatedRoleExists</a></li> |
| <li><a href="#resource_RoleManagementService_unassignRole_GET">./redbackServices/roleManagementService/unassignRole</a></li> |
| <li><a href="#resource_RoleManagementService_unassignRoleByName_GET">./redbackServices/roleManagementService/unassignRoleByName</a></li> |
| <li><a href="#resource_RoleManagementService_updateRole_GET">./redbackServices/roleManagementService/updateRole</a></li> |
| <li><a href="#resource_RoleManagementService_updateRoleDescription_GET">./redbackServices/roleManagementService/updateRoleDescription</a></li> |
| <li><a href="#resource_RoleManagementService_updateRoleUsers_POST">./redbackServices/roleManagementService/updateRoleUsers</a></li> |
| <li><a href="#resource_RoleManagementService_updateUserRoles_POST">./redbackServices/roleManagementService/updateUserRoles</a></li> |
| <li><a href="#resource_RoleManagementService_verifyTemplatedRole_GET">./redbackServices/roleManagementService/verifyTemplatedRole</a></li> |
| </ul> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_getAllRoles_GET"> |
| <h2>GET <small>/roleManagementService/allRoles <a href="./redbackServices/roleManagementService/allRoles" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>array of <a href="json_Role.html">Role</a> |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_role.html">role</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_assignRole_GET"> |
| <h2>GET <small>/roleManagementService/assignRole <a href="./redbackServices/roleManagementService/assignRole" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>Assigns the role indicated by the roleId to the given principal</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>principal</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>roleId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_assignRoleByName_GET"> |
| <h2>GET <small>/roleManagementService/assignRoleByName <a href="./redbackServices/roleManagementService/assignRoleByName" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>Assigns the role indicated by the roleName to the given principal</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>principal</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>roleName</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_assignTemplatedRole_GET"> |
| <h2>GET <small>/roleManagementService/assignTemplatedRole <a href="./redbackServices/roleManagementService/assignTemplatedRole" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>Assigns the templated role indicated by the templateId |
| |
| fails if the templated role has not been created</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>principal</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>resource</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>templateId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_createTemplatedRole_GET"> |
| <h2>GET <small>/roleManagementService/createTemplatedRole <a href="./redbackServices/roleManagementService/createTemplatedRole" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>resource</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>templateId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_getDetailedAllRoles_GET"> |
| <h2>GET <small>/roleManagementService/detailledAllRoles <a href="./redbackServices/roleManagementService/detailledAllRoles" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>array of <a href="json_Role.html">Role</a> |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_role.html">role</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_getApplicationRoles_GET"> |
| <h2>GET <small>/roleManagementService/getApplicationRoles/{username} <a href="./redbackServices/roleManagementService/getApplicationRoles/{username}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>username</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>array of <a href="json_ApplicationRoles.html">ApplicationRoles</a> |
| (JSON)</td> |
| <td rowspan="2"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_applicationRoles.html">applicationRoles</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_getApplications_GET"> |
| <h2>GET <small>/roleManagementService/getApplications/{username} <a href="./redbackServices/roleManagementService/getApplications/{username}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>username</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>array of <a href="json_Application.html">Application</a> |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_application.html">application</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_getEffectivelyAssignedRoles_GET"> |
| <h2>GET <small>/roleManagementService/getEffectivelyAssignedRoles/{username} <a href="./redbackServices/roleManagementService/getEffectivelyAssignedRoles/{username}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>1.4</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>username</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>array of <a href="json_Role.html">Role</a> |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>list of <a href="xml_ns0_role.html">role</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_getRole_GET"> |
| <h2>GET <small>/roleManagementService/getRole/{roleName} <a href="./redbackServices/roleManagementService/getRole/{roleName}" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>roleName</td> |
| <td>path</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td><a href="json_Role.html">Role</a> |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_role.html">role</a> |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_removeTemplatedRole_GET"> |
| <h2>GET <small>/roleManagementService/removeTemplatedRole <a href="./redbackServices/roleManagementService/removeTemplatedRole" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>removes a role corresponding to the role Id that was manufactured with the given resource |
| |
| it also removes any user assignments for that role</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>resource</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>templateId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_roleExists_GET"> |
| <h2>GET <small>/roleManagementService/roleExists <a href="./redbackServices/roleManagementService/roleExists" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>true of a role exists with the given roleId</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>roleId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_templatedRoleExists_GET"> |
| <h2>GET <small>/roleManagementService/templatedRoleExists <a href="./redbackServices/roleManagementService/templatedRoleExists" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>true of a role exists with the given roleId</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>resource</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>templateId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_unassignRole_GET"> |
| <h2>GET <small>/roleManagementService/unassignRole <a href="./redbackServices/roleManagementService/unassignRole" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>Unassigns the role indicated by the role id from the given principal</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>principal</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>roleId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_unassignRoleByName_GET"> |
| <h2>GET <small>/roleManagementService/unassignRoleByName <a href="./redbackServices/roleManagementService/unassignRoleByName" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>Unassigns the role indicated by the role name from the given principal</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>principal</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>roleName</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_updateRole_GET"> |
| <h2>GET <small>/roleManagementService/updateRole <a href="./redbackServices/roleManagementService/updateRole" class="glyphicon glyphicon-new-window" target="_blank"></a></small></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 |
| |
| it also manages any user assignments for that role</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>newResource</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>oldResource</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>templateId</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_updateRoleDescription_GET"> |
| <h2>GET <small>/roleManagementService/updateRoleDescription <a href="./redbackServices/roleManagementService/updateRoleDescription" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p></p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>roleDescription</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>roleName</td> |
| <td>query</td> |
| <td></td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_updateRoleUsers_POST"> |
| <h2>POST <small>/roleManagementService/updateRoleUsers <a href="./redbackServices/roleManagementService/updateRoleUsers" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>update users assigned to a role</p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server.">application/json</abbr></td> |
| <td><a href="json_Role.html">Role</a> |
| (JSON)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_role.html">role</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="2"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <div id="resource_RoleManagementService_updateUserRoles_POST"> |
| <h2>POST <small>/roleManagementService/updateUserRoles <a href="./redbackServices/roleManagementService/updateUserRoles" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>update roles assigned to a user</p> |
| |
| <dl class="dl-horizontal"> |
| <dt>Available Since</dt> |
| <dd>2.0</dd> |
| </dl> |
| |
| <table class="table"> |
| <caption>Request Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server.">application/json</abbr></td> |
| <td><a href="json_User.html">User</a> |
| (JSON)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server.">application/xml</abbr></td> |
| <td><a href="xml_ns0_user.html">user</a> |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="2"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <div id="resource_RoleManagementService_verifyTemplatedRole_GET"> |
| <h2>GET <small>/roleManagementService/verifyTemplatedRole <a href="./redbackServices/roleManagementService/verifyTemplatedRole" class="glyphicon glyphicon-new-window" target="_blank"></a></small></h2> |
| |
| <p>Check a role template is complete in the RBAC store.</p> |
| |
| <table class="table"> |
| <caption>Request Parameters</caption> |
| <thead> |
| <tr> |
| <th>name</th> |
| <th>type</th> |
| <th>description</th> |
| <th>default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>resource</td> |
| <td>query</td> |
| <td>the resource to verify</td> |
| <td>n/a</td> |
| </tr> |
| <tr> |
| <td>templateId</td> |
| <td>query</td> |
| <td>the templated role</td> |
| <td>n/a</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <table class="table"> |
| <caption>Response Body</caption> |
| <thead> |
| <tr> |
| <th>media type</th> |
| <th>data type</th> |
| <th>description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server.">application/json</abbr></td> |
| <td>boolean |
| (JSON)</td> |
| <td rowspan="3"></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server.">application/xml</abbr></td> |
| <td>boolean |
| (XML)</td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: text/plain" HTTP header to request that this media type be provided by the server.">text/plain</abbr></td> |
| <td>object |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <footer> |
| <div class="footer"> |
| Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>. |
| </div> |
| </footer> |
| |
| </div> |
| |
| </div> |
| |
| |
| <!-- JavaScript placed at the end of the document so the pages load faster. --> |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> |
| |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.js" type="text/javascript"></script> |
| |
| |
| </body> |
| </html> |
