irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

user_administration.hpp File Reference
#include "rcConnect.h"
#include "user.hpp"
#include "group.hpp"
#include <vector>
#include <string>
#include <optional>
#include <ostream>
#include <system_error>
#include <stdexcept>
Include dependency graph for user_administration.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  irods::experimental::administration::v1::user_management_error
 

Namespaces

 irods
 
 irods::experimental
 
 irods::experimental::administration
 
 irods::experimental::administration::v1
 
 irods::experimental::administration::client
 
 irods::experimental::administration::client::v1
 

Macros

#define NAMESPACE_IMPL   client
 
#define rxComm   rcComm_t
 

Enumerations

enum  irods::experimental::administration::v1::user_type { irods::experimental::administration::v1::user_type::rodsuser, irods::experimental::administration::v1::user_type::groupadmin, irods::experimental::administration::v1::user_type::rodsadmin }
 
enum  irods::experimental::administration::v1::zone_type { irods::experimental::administration::v1::zone_type::local, irods::experimental::administration::v1::zone_type::remote }
 

Functions

auto irods::experimental::administration::client::v1::add_user (rcComm_t &conn, const user &user, user_type user_type=user_type::rodsuser, zone_type zone_type=zone_type::local) -> std::error_code
 
auto irods::experimental::administration::client::v1::remove_user (rcComm_t &conn, const user &user) -> std::error_code
 
auto irods::experimental::administration::client::v1::set_user_password (rcComm_t &conn, const user &user, std::string_view new_password) -> std::error_code
 
auto irods::experimental::administration::client::v1::set_user_type (rcComm_t &conn, const user &user, user_type new_user_type) -> std::error_code
 
auto irods::experimental::administration::client::v1::add_user_auth (rcComm_t &conn, const user &user, std::string_view auth) -> std::error_code
 
auto irods::experimental::administration::client::v1::remove_user_auth (rcComm_t &conn, const user &user, std::string_view auth) -> std::error_code
 
auto irods::experimental::administration::client::v1::add_group (rcComm_t &conn, const group &group) -> std::error_code
 
auto irods::experimental::administration::client::v1::remove_group (rcComm_t &conn, const group &group) -> std::error_code
 
auto irods::experimental::administration::client::v1::add_user_to_group (rcComm_t &conn, const group &group, const user &user) -> std::error_code
 
auto irods::experimental::administration::client::v1::remove_user_from_group (rcComm_t &conn, const group &group, const user &user) -> std::error_code
 
auto irods::experimental::administration::client::v1::users (rcComm_t &conn) -> std::vector< user >
 
auto irods::experimental::administration::client::v1::users (rcComm_t &conn, const group &group) -> std::vector< user >
 
auto irods::experimental::administration::client::v1::groups (rcComm_t &conn) -> std::vector< group >
 
auto irods::experimental::administration::client::v1::groups (rcComm_t &conn, const user &user) -> std::vector< group >
 
auto irods::experimental::administration::client::v1::exists (rcComm_t &conn, const user &user) -> bool
 
auto irods::experimental::administration::client::v1::exists (rcComm_t &conn, const group &group) -> bool
 
auto irods::experimental::administration::client::v1::id (rcComm_t &conn, const user &user) -> std::optional< std::string >
 
auto irods::experimental::administration::client::v1::id (rcComm_t &conn, const group &group) -> std::optional< std::string >
 
auto irods::experimental::administration::client::v1::type (rcComm_t &conn, const user &user) -> std::optional< user_type >
 
auto irods::experimental::administration::client::v1::auth_names (rcComm_t &conn, const user &user) -> std::vector< std::string >
 
auto irods::experimental::administration::client::v1::user_is_member_of_group (rcComm_t &conn, const group &group, const user &user) -> bool
 
auto irods::experimental::administration::client::v1::local_unique_name (rcComm_t &conn, const user &user) -> std::string
 

Macro Definition Documentation

◆ NAMESPACE_IMPL

#define NAMESPACE_IMPL   client

Definition at line 12 of file user_administration.hpp.

◆ rxComm

#define rxComm   rcComm_t

Definition at line 13 of file user_administration.hpp.