1
0
Fork 0
arangodb/arangod/Documentation/user-management.dox

75 lines
2.8 KiB
Plaintext

////////////////////////////////////////////////////////////////////////////////
/// @brief user management
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2012 triAGENS GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Jan Steemann
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- USER MANAGEMENT
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @page UserManagementTOC
///
/// <ul>
/// <li>@ref UserManagementSave "users.save"</li>
/// <li>@ref UserManagementReplace "users.replace"</li>
/// <li>@ref UserManagementRemove "users.remove"</li>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page UserManagement User Management
///
/// @EMBEDTOC{ UserManagementTOC}
///
/// ArangoDB provides basic functionality to add, modify and remove database
/// users programmatically. The following functionality is provided by the
/// @LIT{users} module and can be used from inside arangosh and arangod.
///
/// Please note that this functionality is not available from within the web
/// interface.
///
/// @CLEARPAGE
/// @anchor UserManagementSave
/// @copydetails JSF_saveUser
///
/// @CLEARPAGE
/// @anchor UserManagementReplace
/// @copydetails JSF_replaceUser
///
/// @CLEARPAGE
/// @anchor UserManagementRemove
/// @copydetails JSF_removeUser
////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- END-OF-FILE
// -----------------------------------------------------------------------------
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
// End: