apidocs/resource_RoleREST.html

<!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">  <title>Ranger REST API: RoleREST</title>  <meta name="viewport" content="width=device-width, initial-scale=1.0">  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">  <link rel="stylesheet" href="css/enunciate.css">   </head> <body data-spy="scroll" data-target="#apinav"> <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">Ranger REST API: RoleREST</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> </ul> </div> </div> </nav> <div class="container-fluid"> <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> <li><a href="#resource_RoleREST_getAllRoles_GET"><abbr title="GET /roles/roles"><span class="sideoverflow">GET /roles/roles</span></abbr></a></li> <li><a href="#resource_RoleREST_createRole_POST"><abbr title="POST /roles/roles"><span class="sideoverflow">POST /roles/roles</span></abbr></a></li> <li><a href="#resource_RoleREST_getRangerRolesIfUpdated_GET"><abbr title="GET /roles/download/{serviceName}"><span class="sideoverflow">GET /roles/download/{serviceName}</span></abbr></a></li> <li><a href="#resource_RoleREST_getAllRolesForUser_GET"><abbr title="GET /roles/lookup/roles"><span class="sideoverflow">GET /roles/lookup/roles</span></abbr></a></li> <li><a href="#resource_RoleREST_getAllRoleNames_GET"><abbr title="GET /roles/roles/names"><span class="sideoverflow">GET /roles/roles/names</span></abbr></a></li> <li><a href="#resource_RoleREST_deleteRole_DELETE"><abbr title="DELETE /roles/roles/{id}"><span class="sideoverflow">DELETE /roles/roles/{id}</span></abbr></a></li> <li><a href="#resource_RoleREST_getRole_GET"><abbr title="GET /roles/roles/{id}"><span class="sideoverflow">GET /roles/roles/{id}</span></abbr></a></li> <li><a href="#resource_RoleREST_updateRole_PUT"><abbr title="PUT /roles/roles/{id}"><span class="sideoverflow">PUT /roles/roles/{id}</span></abbr></a></li> <li><a href="#resource_RoleREST_grantRole_PUT"><abbr title="PUT /roles/roles/grant/{serviceName}"><span class="sideoverflow">PUT /roles/roles/grant/{serviceName}</span></abbr></a></li> <li><a href="#resource_RoleREST_deleteRole_DELETE"><abbr title="DELETE /roles/roles/name/{name}"><span class="sideoverflow">DELETE /roles/roles/name/{name}</span></abbr></a></li> <li><a href="#resource_RoleREST_getRole_GET"><abbr title="GET /roles/roles/name/{name}"><span class="sideoverflow">GET /roles/roles/name/{name}</span></abbr></a></li> <li><a href="#resource_RoleREST_revokeRole_PUT"><abbr title="PUT /roles/roles/revoke/{serviceName}"><span class="sideoverflow">PUT /roles/roles/revoke/{serviceName}</span></abbr></a></li> <li><a href="#resource_RoleREST_getUserRoles_GET"><abbr title="GET /roles/roles/user/{user}"><span class="sideoverflow">GET /roles/roles/user/{user}</span></abbr></a></li> <li><a href="#resource_RoleREST_addUsersAndGroups_PUT"><abbr title="PUT /roles/roles/{id}/addUsersAndGroups"><span class="sideoverflow">PUT /roles/roles/{id}/addUsersAndGroups</span></abbr></a></li> <li><a href="#resource_RoleREST_removeAdminFromUsersAndGroups_PUT"><abbr title="PUT /roles/roles/{id}/removeAdminFromUsersAndGroups"><span class="sideoverflow">PUT /roles/roles/{id}/removeAdminFromUsersAndGroups</span></abbr></a></li> <li><a href="#resource_RoleREST_removeUsersAndGroups_PUT"><abbr title="PUT /roles/roles/{id}/removeUsersAndGroups"><span class="sideoverflow">PUT /roles/roles/{id}/removeUsersAndGroups</span></abbr></a></li> <li><a href="#resource_RoleREST_getSecureRangerRolesIfUpdated_GET"><abbr title="GET /roles/secure/download/{serviceName}"><span class="sideoverflow">GET /roles/secure/download/{serviceName}</span></abbr></a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> <ol class="breadcrumb" id="top"> <li class="active dropdown"><a href="index.html">Home</a></li> <li class="active dropdown"><a href="resources.html">Resources</a></li> <li class="dropdown"><a href="resource_RoleREST.html">RoleREST</a></li> </ol> <h1 class="page-header">RoleREST <small>Resource</small></h1> <p></p> <div id="resource_RoleREST_getAllRoles_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles <a href="../roles/roles" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRoleList.html">RangerRoleList</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRoleList.html">rangerRoleList</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/roles Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "roles" : [ { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true }, { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_createRole_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/roles/roles <a href="../roles/roles" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>default</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">createNonExistUserGroup</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value">false</span></td> <td><span class="parameter-constraints">boolean</span></td> </tr> <tr> <td><span class="parameter-name">serviceName</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints"> </span></td> </tr> </tbody> </table> <table class="table resource-request-body"> <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."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> POST /roles/roles Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Created Content-Type: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_getRangerRolesIfUpdated_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/download/{serviceName} <a href="../roles/download/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>default</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">serviceName</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">clusterName</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"></span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">lastActivationTime</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value">0</span></td> <td><span class="parameter-constraints">long</span></td> </tr> <tr> <td><span class="parameter-name">lastKnownRoleVersion</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints">long</span></td> </tr> <tr> <td><span class="parameter-name">pluginCapabilities</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"></span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">pluginId</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints"> </span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRoles.html">RangerRoles</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRoles.html">rangerRoles</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/download/{serviceName} Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "roleVersion" : 12345, "serviceName" : "...", "roleUpdateTime" : 12345, "rangerRoles" : [ { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true }, { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } ] } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_getAllRolesForUser_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/lookup/roles <a href="../roles/lookup/roles" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRoleList.html">RangerRoleList</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRoleList.html">rangerRoleList</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/lookup/roles Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "roles" : [ { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true }, { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } ], "listSize" : 12345, "list" : [ { }, { } ], "startIndex" : 12345, "pageSize" : 12345, "totalCount" : 12345, "resultSize" : 12345, "sortType" : "...", "sortBy" : "..." } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_getAllRoleNames_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/names <a href="../roles/roles/names" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">execUser</span></td> <td>query</td> <td><span class="parameter-description"></span></td> </tr> <tr> <td><span class="parameter-name">serviceName</span></td> <td>query</td> <td><span class="parameter-description"></span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of string (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of string (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/roles/names Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_deleteRole_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/roles/roles/{id} <a href="../roles/roles/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /roles/roles/{id} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_RoleREST_getRole_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/{id} <a href="../roles/roles/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/roles/{id} Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_updateRole_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/{id} <a href="../roles/roles/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>default</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">id</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints">long</span></td> </tr> <tr> <td><span class="parameter-name">createNonExistUserGroup</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value">false</span></td> <td><span class="parameter-constraints">boolean</span></td> </tr> </tbody> </table> <table class="table resource-request-body"> <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."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /roles/roles/{id} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_grantRole_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/grant/{serviceName} <a href="../roles/roles/grant/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">serviceName</span></td> <td>path</td> <td><span class="parameter-description"></span></td> </tr> </tbody> </table> <table class="table resource-request-body"> <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."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_GrantRevokeRoleRequest.html">GrantRevokeRoleRequest</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_grantRevokeRoleRequest.html">grantRevokeRoleRequest</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RESTResponse.html">RESTResponse</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_RESTResponse.html">RESTResponse</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /roles/roles/grant/{serviceName} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "users" : [ "...", "..." ], "requestData" : "...", "grantorGroups" : [ "...", "..." ], "clientType" : "...", "targetRoles" : [ "...", "..." ], "clusterName" : "...", "grantOption" : true, "clientIPAddress" : "...", "sessionId" : "...", "grantor" : "...", "groups" : [ "...", "..." ], "roles" : [ "...", "..." ] } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "message" : "...", "msgDesc" : "...", "httpStatusCode" : 12345, "messageList" : [ { "fieldName" : "...", "objectId" : 12345, "rbKey" : "...", "message" : "...", "name" : "..." }, { "fieldName" : "...", "objectId" : 12345, "rbKey" : "...", "message" : "...", "name" : "..." } ], "statusCode" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_deleteRole_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/roles/roles/name/{name} <a href="../roles/roles/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">name</span></td> <td>path</td> <td><span class="parameter-description"></span></td> </tr> <tr> <td><span class="parameter-name">execUser</span></td> <td>query</td> <td><span class="parameter-description"></span></td> </tr> <tr> <td><span class="parameter-name">serviceName</span></td> <td>query</td> <td><span class="parameter-description"></span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /roles/roles/name/{name} Content-Type: */* <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content </pre> </div> </div> </div> </div> <div id="resource_RoleREST_getRole_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/name/{name} <a href="../roles/roles/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">name</span></td> <td>path</td> <td><span class="parameter-description"></span></td> </tr> <tr> <td><span class="parameter-name">execUser</span></td> <td>query</td> <td><span class="parameter-description"></span></td> </tr> <tr> <td><span class="parameter-name">serviceName</span></td> <td>query</td> <td><span class="parameter-description"></span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/roles/name/{name} Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_revokeRole_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/revoke/{serviceName} <a href="../roles/roles/revoke/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">serviceName</span></td> <td>path</td> <td><span class="parameter-description"></span></td> </tr> </tbody> </table> <table class="table resource-request-body"> <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."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_GrantRevokeRoleRequest.html">GrantRevokeRoleRequest</a> (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_grantRevokeRoleRequest.html">grantRevokeRoleRequest</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RESTResponse.html">RESTResponse</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_RESTResponse.html">RESTResponse</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /roles/roles/revoke/{serviceName} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "users" : [ "...", "..." ], "requestData" : "...", "grantorGroups" : [ "...", "..." ], "clientType" : "...", "targetRoles" : [ "...", "..." ], "clusterName" : "...", "grantOption" : true, "clientIPAddress" : "...", "sessionId" : "...", "grantor" : "...", "groups" : [ "...", "..." ], "roles" : [ "...", "..." ] } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "message" : "...", "msgDesc" : "...", "httpStatusCode" : 12345, "messageList" : [ { "fieldName" : "...", "objectId" : 12345, "rbKey" : "...", "message" : "...", "name" : "..." }, { "fieldName" : "...", "objectId" : 12345, "rbKey" : "...", "message" : "...", "name" : "..." } ], "statusCode" : 12345 } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_getUserRoles_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/user/{user} <a href="../roles/roles/user/{user}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">user</span></td> <td>path</td> <td><span class="parameter-description"></span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of string (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of string (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/roles/user/{user} Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_addUsersAndGroups_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/{id}/addUsersAndGroups <a href="../roles/roles/{id}/addUsersAndGroups" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-request-body"> <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."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">boolean (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">boolean (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /roles/roles/{id}/addUsersAndGroups Content-Type: application/json Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_removeAdminFromUsersAndGroups_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/{id}/removeAdminFromUsersAndGroups <a href="../roles/roles/{id}/removeAdminFromUsersAndGroups" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-request-body"> <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."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of string (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of string (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /roles/roles/{id}/removeAdminFromUsersAndGroups Content-Type: application/json Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_removeUsersAndGroups_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/{id}/removeUsersAndGroups <a href="../roles/roles/{id}/removeUsersAndGroups" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-request-body"> <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."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of string (JSON)</span></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."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of string (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> PUT /roles/roles/{id}/removeUsersAndGroups Content-Type: application/json Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 No Content Content-Type: application/json <code class="prettyprint language-js"> { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_RoleREST_getSecureRangerRolesIfUpdated_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/secure/download/{serviceName} <a href="../roles/secure/download/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>default</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">serviceName</span></td> <td>path</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">clusterName</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"></span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">lastActivationTime</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value">0</span></td> <td><span class="parameter-constraints">long</span></td> </tr> <tr> <td><span class="parameter-name">lastKnownRoleVersion</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints">long</span></td> </tr> <tr> <td><span class="parameter-name">pluginCapabilities</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"></span></td> <td><span class="parameter-constraints"> </span></td> </tr> <tr> <td><span class="parameter-name">pluginId</span></td> <td>query</td> <td><span class="parameter-description"></span></td> <td><span class="parameter-default-value"> </span></td> <td><span class="parameter-constraints"> </span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <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."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_RangerRoles.html">RangerRoles</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description"></span></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."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_rangerRoles.html">rangerRoles</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /roles/secure/download/{serviceName} Content-Type: */* Accept: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 OK Content-Type: application/json <code class="prettyprint language-js"> { "roleVersion" : 12345, "serviceName" : "...", "roleUpdateTime" : 12345, "rangerRoles" : [ { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true }, { "createdByUser" : "...", "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "name" : "...", "options" : { "property1" : { }, "property2" : { } }, "description" : "...", "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } ] } </code> </pre> </div> </div> </div> </div> <footer class="footer"> <div class="container"> <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> </div> </footer> </div> </div> </div>  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> <script> $(function() { $(".clickable-row").click(function() { window.document.location = $(this).data("href"); }); $('[data-toggle="tooltip"]').tooltip() }); </script> </body> </html>

apidocs/resource_RoleREST.html (2,131 lines of code) (raw):