You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ranger.apache.org by rm...@apache.org on 2021/11/05 18:32:07 UTC
svn commit: r1894763 [18/31] - in /ranger/site/trunk: ./ apidocs/
apidocs/ui/ kms/apidocs/ kms/apidocs/ui/
Modified: ranger/site/trunk/apidocs/resource_XUserREST.html
URL: http://svn.apache.org/viewvc/ranger/site/trunk/apidocs/resource_XUserREST.html?rev=1894763&r1=1894762&r2=1894763&view=diff
==============================================================================
--- ranger/site/trunk/apidocs/resource_XUserREST.html (original)
+++ ranger/site/trunk/apidocs/resource_XUserREST.html Fri Nov 5 18:32:04 2021
@@ -101,7 +101,13 @@
<li><a href="#resource_XUserREST_secureCreateXGroup_POST"><abbr title="POST /xusers/secure/groups"><span class="sideoverflow">POST /xusers/secure/groups</span></abbr></a></li>
<li><a href="#resource_XUserREST_secureCreateXUser_POST"><abbr title="POST /xusers/secure/users"><span class="sideoverflow">POST /xusers/secure/users</span></abbr></a></li>
<li><a href="#resource_XUserREST_postUserGroupAuditInfo_POST"><abbr title="POST /xusers/ugsync/auditinfo"><span class="sideoverflow">POST /xusers/ugsync/auditinfo</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_addOrUpdateGroups_POST"><abbr title="POST /xusers/ugsync/groups"><span class="sideoverflow">POST /xusers/ugsync/groups</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_getAllGroupUsers_GET"><abbr title="GET /xusers/ugsync/groupusers"><span class="sideoverflow">GET /xusers/ugsync/groupusers</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_addOrUpdateGroupUsersList_POST"><abbr title="POST /xusers/ugsync/groupusers"><span class="sideoverflow">POST /xusers/ugsync/groupusers</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_addOrUpdateUsers_POST"><abbr title="POST /xusers/ugsync/users"><span class="sideoverflow">POST /xusers/ugsync/users</span></abbr></a></li>
<li><a href="#resource_XUserREST_countXUsers_GET"><abbr title="GET /xusers/users/count"><span class="sideoverflow">GET /xusers/users/count</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_createExternalUser_POST"><abbr title="POST /xusers/users/external"><span class="sideoverflow">POST /xusers/users/external</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_setXUserRolesByName_POST"><abbr title="POST /xusers/users/roleassignments"><span class="sideoverflow">POST /xusers/users/roleassignments</span></abbr></a></li>
<li><a href="#resource_XUserREST_createXUserGroupFromMap_POST"><abbr title="POST /xusers/users/userinfo"><span class="sideoverflow">POST /xusers/users/userinfo</span></abbr></a></li>
<li><a href="#resource_XUserREST_deleteXUser_DELETE"><abbr title="DELETE /xusers/users/{id}"><span class="sideoverflow">DELETE /xusers/users/{id}</span></abbr></a></li>
<li><a href="#resource_XUserREST_getXUser_GET"><abbr title="GET /xusers/users/{id}"><span class="sideoverflow">GET /xusers/users/{id}</span></abbr></a></li>
@@ -118,6 +124,7 @@
<li><a href="#resource_XUserREST_deleteXUserPermission_DELETE"><abbr title="DELETE /xusers/permission/user/{id}"><span class="sideoverflow">DELETE /xusers/permission/user/{id}</span></abbr></a></li>
<li><a href="#resource_XUserREST_getXUserPermission_GET"><abbr title="GET /xusers/permission/user/{id}"><span class="sideoverflow">GET /xusers/permission/user/{id}</span></abbr></a></li>
<li><a href="#resource_XUserREST_updateXUserPermission_PUT"><abbr title="PUT /xusers/permission/user/{id}"><span class="sideoverflow">PUT /xusers/permission/user/{id}</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_getSecureRangerUserStoreIfUpdated_GET"><abbr title="GET /xusers/secure/download/{serviceName}"><span class="sideoverflow">GET /xusers/secure/download/{serviceName}</span></abbr></a></li>
<li><a href="#resource_XUserREST_deleteGroupsByGroupName_DELETE"><abbr title="DELETE /xusers/secure/groups/delete"><span class="sideoverflow">DELETE /xusers/secure/groups/delete</span></abbr></a></li>
<li><a href="#resource_XUserREST_modifyGroupsVisibility_PUT"><abbr title="PUT /xusers/secure/groups/visibility"><span class="sideoverflow">PUT /xusers/secure/groups/visibility</span></abbr></a></li>
<li><a href="#resource_XUserREST_deleteSingleGroupByGroupName_DELETE"><abbr title="DELETE /xusers/secure/groups/{groupName}"><span class="sideoverflow">DELETE /xusers/secure/groups/{groupName}</span></abbr></a></li>
@@ -129,6 +136,8 @@
<li><a href="#resource_XUserREST_secureGetXUser_GET"><abbr title="GET /xusers/secure/users/{id}"><span class="sideoverflow">GET /xusers/secure/users/{id}</span></abbr></a></li>
<li><a href="#resource_XUserREST_secureUpdateXUser_PUT"><abbr title="PUT /xusers/secure/users/{id}"><span class="sideoverflow">PUT /xusers/secure/users/{id}</span></abbr></a></li>
<li><a href="#resource_XUserREST_deleteSingleUserByUserName_DELETE"><abbr title="DELETE /xusers/secure/users/{userName}"><span class="sideoverflow">DELETE /xusers/secure/users/{userName}</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_updateDeletedGroups_POST"><abbr title="POST /xusers/ugsync/groups/visibility"><span class="sideoverflow">POST /xusers/ugsync/groups/visibility</span></abbr></a></li>
+ <li><a href="#resource_XUserREST_updateDeletedUsers_POST"><abbr title="POST /xusers/ugsync/users/visibility"><span class="sideoverflow">POST /xusers/ugsync/users/visibility</span></abbr></a></li>
<li><a href="#resource_XUserREST_deleteXUserByUserName_DELETE"><abbr title="DELETE /xusers/users/userName/{userName}"><span class="sideoverflow">DELETE /xusers/users/userName/{userName}</span></abbr></a></li>
<li><a href="#resource_XUserREST_getXUserByUserName_GET"><abbr title="GET /xusers/users/userName/{userName}"><span class="sideoverflow">GET /xusers/users/userName/{userName}</span></abbr></a></li>
<li><a href="#resource_XUserREST_deleteXGroupAndXUser_DELETE"><abbr title="DELETE /xusers/group/{groupName}/user/{userName}"><span class="sideoverflow">DELETE /xusers/group/{groupName}/user/{userName}</span></abbr></a></li>
@@ -921,6 +930,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -934,6 +945,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -1026,6 +1039,8 @@ Accept: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -1050,6 +1065,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -1133,6 +1150,8 @@ Accept: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -1157,6 +1176,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -2283,6 +2304,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -2303,6 +2326,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -2402,6 +2427,8 @@ Accept: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -2433,6 +2460,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -2523,6 +2552,8 @@ Accept: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -2554,6 +2585,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -3187,6 +3220,8 @@ Accept: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -3208,6 +3243,8 @@ Accept: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -3228,6 +3265,8 @@ Accept: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -3260,6 +3299,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -3281,6 +3322,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -3301,6 +3344,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -3450,6 +3495,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -4961,6 +5008,8 @@ Accept: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -4985,6 +5034,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5075,6 +5126,8 @@ Accept: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5106,6 +5159,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5198,14 +5253,18 @@ Accept: application/json
"totalGroupsSynced" : 12345,
"groupSearchFirstEnabled" : "...",
"groupSearchEnabled" : "...",
- "userSearchEnabled" : "..."
+ "userSearchEnabled" : "...",
+ "totalUsersDeleted" : 12345,
+ "totalGroupsDeleted" : 12345
},
"fileSyncSourceInfo" : {
"fileName" : "...",
"syncTime" : "...",
"lastModified" : "...",
"totalUsersSynced" : 12345,
- "totalGroupsSynced" : 12345
+ "totalGroupsSynced" : 12345,
+ "totalUsersDeleted" : 12345,
+ "totalGroupsDeleted" : 12345
},
"unixSyncSourceInfo" : {
"fileName" : "...",
@@ -5215,7 +5274,9 @@ Accept: application/json
"minUserId" : "...",
"minGroupId" : "...",
"totalUsersSynced" : 12345,
- "totalGroupsSynced" : 12345
+ "totalGroupsSynced" : 12345,
+ "totalUsersDeleted" : 12345,
+ "totalGroupsDeleted" : 12345
},
"sessionId" : "...",
"syncSourceInfo" : {
@@ -5256,14 +5317,18 @@ Content-Type: application/json
"totalGroupsSynced" : 12345,
"groupSearchFirstEnabled" : "...",
"groupSearchEnabled" : "...",
- "userSearchEnabled" : "..."
+ "userSearchEnabled" : "...",
+ "totalUsersDeleted" : 12345,
+ "totalGroupsDeleted" : 12345
},
"fileSyncSourceInfo" : {
"fileName" : "...",
"syncTime" : "...",
"lastModified" : "...",
"totalUsersSynced" : 12345,
- "totalGroupsSynced" : 12345
+ "totalGroupsSynced" : 12345,
+ "totalUsersDeleted" : 12345,
+ "totalGroupsDeleted" : 12345
},
"unixSyncSourceInfo" : {
"fileName" : "...",
@@ -5273,7 +5338,9 @@ Content-Type: application/json
"minUserId" : "...",
"minGroupId" : "...",
"totalUsersSynced" : 12345,
- "totalGroupsSynced" : 12345
+ "totalGroupsSynced" : 12345,
+ "totalUsersDeleted" : 12345,
+ "totalGroupsDeleted" : 12345
},
"sessionId" : "...",
"syncSourceInfo" : {
@@ -5294,6 +5361,406 @@ Content-Type: application/json
</div>
</div>
+ <div id="resource_XUserREST_addOrUpdateGroups_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/groups <a href="../xusers/ugsync/groups" 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"><a href="json_VXGroupList.html">VXGroupList</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_VXGroupList.html">VXGroupList</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">number
+ (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">int
+ (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 /xusers/ugsync/groups
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "vXGroups" : [ {
+ "name" : "...",
+ "description" : "...",
+ "groupType" : 12345,
+ "credStoreId" : 12345,
+ "isVisible" : 12345,
+ "myClassType" : 12345,
+ "groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
+ "id" : 12345,
+ "createDate" : 12345,
+ "updateDate" : 12345,
+ "owner" : "...",
+ "updatedBy" : "..."
+ }, {
+ "name" : "...",
+ "description" : "...",
+ "groupType" : 12345,
+ "credStoreId" : 12345,
+ "isVisible" : 12345,
+ "myClassType" : 12345,
+ "groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
+ "id" : 12345,
+ "createDate" : 12345,
+ "updateDate" : 12345,
+ "owner" : "...",
+ "updatedBy" : "..."
+ } ],
+ "listSize" : 12345,
+ "list" : [ { }, { } ],
+ "startIndex" : 12345,
+ "pageSize" : 12345,
+ "totalCount" : 12345,
+ "resultSize" : 12345,
+ "sortType" : "...",
+ "sortBy" : "..."
+}
+ </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-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_XUserREST_getAllGroupUsers_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/ugsync/groupusers <a href="../xusers/ugsync/groupusers" 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">map of 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">(custom)
+ (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 /xusers/ugsync/groupusers
+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_XUserREST_addOrUpdateGroupUsersList_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/groupusers <a href="../xusers/ugsync/groupusers" 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 <a href="json_GroupUserInfo.html">GroupUserInfo</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">list of <a href="xml_ns0_groupUserInfo.html">groupUserInfo</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">number
+ (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">int
+ (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 /xusers/ugsync/groupusers
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+[ {
+ "groupName" : "...",
+ "delUsers" : [ "...", "..." ],
+ "addUsers" : [ "...", "..." ]
+} ]
+ </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-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_XUserREST_addOrUpdateUsers_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/users <a href="../xusers/ugsync/users" 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"><a href="json_VXUserList.html">VXUserList</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_VXUserList.html">VXUserList</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">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">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>
+POST /xusers/ugsync/users
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "vXUsers" : [ {
+ "name" : "...",
+ "firstName" : "...",
+ "lastName" : "...",
+ "emailAddress" : "...",
+ "password" : "...",
+ "description" : "...",
+ "credStoreId" : 12345,
+ "groupIdList" : [ 12345, 12345 ],
+ "myClassType" : 12345,
+ "status" : 12345,
+ "isVisible" : 12345,
+ "userSource" : 12345,
+ "userRoleList" : [ "...", "..." ],
+ "groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
+ "id" : 12345,
+ "createDate" : 12345,
+ "updateDate" : 12345,
+ "owner" : "...",
+ "updatedBy" : "..."
+ }, {
+ "name" : "...",
+ "firstName" : "...",
+ "lastName" : "...",
+ "emailAddress" : "...",
+ "password" : "...",
+ "description" : "...",
+ "credStoreId" : 12345,
+ "groupIdList" : [ 12345, 12345 ],
+ "myClassType" : 12345,
+ "status" : 12345,
+ "isVisible" : 12345,
+ "userSource" : 12345,
+ "userRoleList" : [ "...", "..." ],
+ "groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
+ "id" : 12345,
+ "createDate" : 12345,
+ "updateDate" : 12345,
+ "owner" : "...",
+ "updatedBy" : "..."
+ } ],
+ "listSize" : 12345,
+ "list" : [ { }, { } ],
+ "startIndex" : 12345,
+ "pageSize" : 12345,
+ "totalCount" : 12345,
+ "resultSize" : 12345,
+ "sortType" : "...",
+ "sortBy" : "..."
+}
+ </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-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_XUserREST_countXUsers_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/users/count <a href="../xusers/users/count" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -5356,6 +5823,222 @@ Content-Type: application/json
</div>
</div>
+ <div id="resource_XUserREST_createExternalUser_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/users/external <a href="../xusers/users/external" 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"><a href="json_VXUser.html">VXUser</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_VXUser.html">VXUser</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_VXUser.html">VXUser</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_VXUser.html">VXUser</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 /xusers/users/external
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "name" : "...",
+ "firstName" : "...",
+ "lastName" : "...",
+ "emailAddress" : "...",
+ "password" : "...",
+ "description" : "...",
+ "credStoreId" : 12345,
+ "groupIdList" : [ 12345, 12345 ],
+ "myClassType" : 12345,
+ "status" : 12345,
+ "isVisible" : 12345,
+ "userSource" : 12345,
+ "userRoleList" : [ "...", "..." ],
+ "groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
+ "id" : 12345,
+ "createDate" : 12345,
+ "updateDate" : 12345,
+ "owner" : "...",
+ "updatedBy" : "..."
+}
+ </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">
+{
+ "name" : "...",
+ "firstName" : "...",
+ "lastName" : "...",
+ "emailAddress" : "...",
+ "password" : "...",
+ "description" : "...",
+ "credStoreId" : 12345,
+ "groupIdList" : [ 12345, 12345 ],
+ "myClassType" : 12345,
+ "status" : 12345,
+ "isVisible" : 12345,
+ "userSource" : 12345,
+ "userRoleList" : [ "...", "..." ],
+ "groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
+ "id" : 12345,
+ "createDate" : 12345,
+ "updateDate" : 12345,
+ "owner" : "...",
+ "updatedBy" : "..."
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_XUserREST_setXUserRolesByName_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/users/roleassignments <a href="../xusers/users/roleassignments" 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"><a href="json_UsersGroupRoleAssignments.html">UsersGroupRoleAssignments</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_usersGroupRoleAssignments.html">usersGroupRoleAssignments</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">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>
+POST /xusers/users/roleassignments
+Content-Type: application/json
+Accept: application/json
+
+ <code class="prettyprint language-js">
+{
+ "userRoleAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "groupRoleAssignments" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "users" : [ "...", "..." ]
+}
+ </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-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_XUserREST_createXUserGroupFromMap_POST">
<h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/users/userinfo <a href="../xusers/users/userinfo" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -5434,6 +6117,8 @@ Accept: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5448,6 +6133,8 @@ Accept: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5461,6 +6148,8 @@ Accept: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5500,6 +6189,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5514,6 +6205,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5527,6 +6220,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5683,6 +6378,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5783,6 +6480,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5803,6 +6502,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5905,6 +6606,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -5918,6 +6621,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -6065,6 +6770,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -6156,6 +6863,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -6177,6 +6886,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -6197,6 +6908,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -6836,6 +7549,145 @@ Content-Type: application/json
</div>
</div>
+ <div id="resource_XUserREST_getSecureRangerUserStoreIfUpdated_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/xusers/secure/download/{serviceName} <a href="../xusers/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">lastKnownUserStoreVersion</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_RangerUserStore.html">RangerUserStore</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_rangerUserStore.html">rangerUserStore</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 /xusers/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">
+{
+ "groupCloudIdMapping" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "userAttrMapping" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "userCloudIdMapping" : {
+ "property1" : "...",
+ "property2" : "..."
+ },
+ "userStoreUpdateTime" : 12345,
+ "userGroupMapping" : {
+ "property1" : [ "...", "..." ],
+ "property2" : [ "...", "..." ]
+ },
+ "groupAttrMapping" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "userStoreVersion" : 12345
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_XUserREST_deleteGroupsByGroupName_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/secure/groups/delete <a href="../xusers/secure/groups/delete" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -7083,6 +7935,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -7166,6 +8020,8 @@ Accept: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -7190,6 +8046,8 @@ Content-Type: application/json
"isVisible" : 12345,
"myClassType" : 12345,
"groupSource" : 12345,
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -7461,6 +8319,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -7551,6 +8411,8 @@ Accept: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -7582,6 +8444,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
@@ -7643,6 +8507,168 @@ HTTP/1.1 204 No Content
</div>
</div>
+ <div id="resource_XUserREST_updateDeletedGroups_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/groups/visibility <a href="../xusers/ugsync/groups/visibility" 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">number
+ (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">int
+ (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 /xusers/ugsync/groups/visibility
+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 201 Created
+Content-Type: application/json
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_XUserREST_updateDeletedUsers_POST">
+ <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/xusers/ugsync/users/visibility <a href="../xusers/ugsync/users/visibility" 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">number
+ (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">int
+ (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 /xusers/ugsync/users/visibility
+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 201 Created
+Content-Type: application/json
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_XUserREST_deleteXUserByUserName_DELETE">
<h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/xusers/users/userName/{userName} <a href="../xusers/users/userName/{userName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -7775,6 +8801,8 @@ Content-Type: application/json
"userSource" : 12345,
"userRoleList" : [ "...", "..." ],
"groupNameList" : [ "...", "..." ],
+ "otherAttributes" : "...",
+ "syncSource" : "...",
"id" : 12345,
"createDate" : 12345,
"updateDate" : 12345,
Modified: ranger/site/trunk/apidocs/resources.html
URL: http://svn.apache.org/viewvc/ranger/site/trunk/apidocs/resources.html?rev=1894763&r1=1894762&r2=1894763&view=diff
==============================================================================
--- ranger/site/trunk/apidocs/resources.html (original)
+++ ranger/site/trunk/apidocs/resources.html Fri Nov 5 18:32:04 2021
@@ -129,6 +129,16 @@
<td> <span class="resource-description"></span>
</td>
</tr>
+ <tr class="clickable-row" data-href="resource_MetricsREST.html">
+ <td> <span class="resource-name">MetricsREST</span>
+</td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/metrics/status</span>
+</samp></li></ul></td>
+ <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li></ul></td>
+ <td> <span class="resource-description"></span>
+</td>
+ </tr>
<tr class="clickable-row" data-href="resource_PublicAPIs.html">
<td> <span class="resource-name">PublicAPIs</span>
</td>
@@ -163,6 +173,7 @@
</samp></li><li><samp> <span class="resource-path">/public/v2/api/roles/names</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/roles/{id}</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/server/policydeltas</span>
+</samp></li><li><samp> <span class="resource-path">/public/v2/api/server/tagdeltas</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/service/{id}</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/servicedef/{id}</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/zones/{id}</span>
@@ -174,6 +185,7 @@
</samp></li><li><samp> <span class="resource-path">/public/v2/api/roles/{id}/addUsersAndGroups</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/roles/{id}/removeAdminFromUsersAndGroups</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/roles/{id}/removeUsersAndGroups</span>
+</samp></li><li><samp> <span class="resource-path">/public/v2/api/server/purgepolicies/{serviceName}</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/service/name/{name}</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/service/{servicename}/policy</span>
</samp></li><li><samp> <span class="resource-path">/public/v2/api/servicedef/name/{name}</span>
@@ -191,6 +203,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
@@ -202,6 +215,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
@@ -215,6 +229,8 @@
<td> <span class="resource-name">RoleREST</span>
</td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/roles/roles</span>
+</samp></li><li><samp> <span class="resource-path">/roles/download/{serviceName}</span>
+</samp></li><li><samp> <span class="resource-path">/roles/lookup/roles</span>
</samp></li><li><samp> <span class="resource-path">/roles/roles/names</span>
</samp></li><li><samp> <span class="resource-path">/roles/roles/{id}</span>
</samp></li><li><samp> <span class="resource-path">/roles/roles/grant/{serviceName}</span>
@@ -224,9 +240,12 @@
</samp></li><li><samp> <span class="resource-path">/roles/roles/{id}/addUsersAndGroups</span>
</samp></li><li><samp> <span class="resource-path">/roles/roles/{id}/removeAdminFromUsersAndGroups</span>
</samp></li><li><samp> <span class="resource-path">/roles/roles/{id}/removeUsersAndGroups</span>
+</samp></li><li><samp> <span class="resource-path">/roles/secure/download/{serviceName}</span>
</samp></li></ul></td>
<td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
@@ -235,6 +254,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li></ul></td>
<td> <span class="resource-description"></span>
</td>
@@ -262,6 +282,7 @@
</samp></li><li><samp> <span class="resource-path">/plugins/policies</span>
</samp></li><li><samp> <span class="resource-path">/plugins/policyLabels</span>
</samp></li><li><samp> <span class="resource-path">/plugins/services</span>
+</samp></li><li><samp> <span class="resource-path">/plugins/cluster-services/{clusterName}</span>
</samp></li><li><samp> <span class="resource-path">/plugins/definitions/{id}</span>
</samp></li><li><samp> <span class="resource-path">/plugins/plugins/info</span>
</samp></li><li><samp> <span class="resource-path">/plugins/policies/apply</span>
@@ -282,6 +303,7 @@
</samp></li><li><samp> <span class="resource-path">/plugins/policies/service/{id}</span>
</samp></li><li><samp> <span class="resource-path">/plugins/policies/{serviceDefName}/for-resource</span>
</samp></li><li><samp> <span class="resource-path">/plugins/policy/{policyId}/versionList</span>
+</samp></li><li><samp> <span class="resource-path">/plugins/server/purgepolicies/{serviceName}</span>
</samp></li><li><samp> <span class="resource-path">/plugins/services/grant/{serviceName}</span>
</samp></li><li><samp> <span class="resource-path">/plugins/services/lookupResource/{serviceName}</span>
</samp></li><li><samp> <span class="resource-path">/plugins/services/name/{name}</span>
@@ -298,6 +320,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
@@ -318,6 +341,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
@@ -342,6 +366,7 @@
</samp></li><li><samp> <span class="resource-path">/tags/types</span>
</samp></li><li><samp> <span class="resource-path">/tags/download/{serviceName}</span>
</samp></li><li><samp> <span class="resource-path">/tags/resource/{id}</span>
+</samp></li><li><samp> <span class="resource-path">/tags/server/tagdeltas</span>
</samp></li><li><samp> <span class="resource-path">/tags/tag/{id}</span>
</samp></li><li><samp> <span class="resource-path">/tags/tagdef/{id}</span>
</samp></li><li><samp> <span class="resource-path">/tags/tagresourcemap/tag-resource-guid</span>
@@ -364,6 +389,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
@@ -471,7 +497,12 @@
</samp></li><li><samp> <span class="resource-path">/xusers/secure/groups</span>
</samp></li><li><samp> <span class="resource-path">/xusers/secure/users</span>
</samp></li><li><samp> <span class="resource-path">/xusers/ugsync/auditinfo</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/ugsync/groups</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/ugsync/groupusers</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/ugsync/users</span>
</samp></li><li><samp> <span class="resource-path">/xusers/users/count</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/users/external</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/users/roleassignments</span>
</samp></li><li><samp> <span class="resource-path">/xusers/users/userinfo</span>
</samp></li><li><samp> <span class="resource-path">/xusers/users/{id}</span>
</samp></li><li><samp> <span class="resource-path">/xusers/{groupId}/users</span>
@@ -482,6 +513,7 @@
</samp></li><li><samp> <span class="resource-path">/xusers/permission/group/{id}</span>
</samp></li><li><samp> <span class="resource-path">/xusers/permission/user/count</span>
</samp></li><li><samp> <span class="resource-path">/xusers/permission/user/{id}</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/secure/download/{serviceName}</span>
</samp></li><li><samp> <span class="resource-path">/xusers/secure/groups/delete</span>
</samp></li><li><samp> <span class="resource-path">/xusers/secure/groups/visibility</span>
</samp></li><li><samp> <span class="resource-path">/xusers/secure/groups/{groupName}</span>
@@ -491,6 +523,8 @@
</samp></li><li><samp> <span class="resource-path">/xusers/secure/users/visibility</span>
</samp></li><li><samp> <span class="resource-path">/xusers/secure/users/{id}</span>
</samp></li><li><samp> <span class="resource-path">/xusers/secure/users/{userName}</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/ugsync/groups/visibility</span>
+</samp></li><li><samp> <span class="resource-path">/xusers/ugsync/users/visibility</span>
</samp></li><li><samp> <span class="resource-path">/xusers/users/userName/{userName}</span>
</samp></li><li><samp> <span class="resource-path">/xusers/group/{groupName}/user/{userName}</span>
</samp></li><li><samp> <span class="resource-path">/xusers/secure/groups/id/{groupId}</span>
@@ -528,8 +562,13 @@
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
@@ -539,6 +578,7 @@
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
+</samp></li><li><samp> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
@@ -548,6 +588,8 @@
</samp></li><li><samp> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">PUT</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
+</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
+</samp></li><li><samp> <span class="label label-default resource-method">POST</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>
</samp></li><li><samp> <span class="label label-default resource-method">DELETE</span>