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)  

irods::experimental::administration::client::v1 Namespace Reference

Functions

auto 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 remove_user (rcComm_t &conn, const user &user) -> std::error_code
 
auto set_user_password (rcComm_t &conn, const user &user, std::string_view new_password) -> std::error_code
 
auto set_user_type (rcComm_t &conn, const user &user, user_type new_user_type) -> std::error_code
 
auto add_user_auth (rcComm_t &conn, const user &user, std::string_view auth) -> std::error_code
 
auto remove_user_auth (rcComm_t &conn, const user &user, std::string_view auth) -> std::error_code
 
auto add_group (rcComm_t &conn, const group &group) -> std::error_code
 
auto remove_group (rcComm_t &conn, const group &group) -> std::error_code
 
auto add_user_to_group (rcComm_t &conn, const group &group, const user &user) -> std::error_code
 
auto remove_user_from_group (rcComm_t &conn, const group &group, const user &user) -> std::error_code
 
auto users (rcComm_t &conn) -> std::vector< user >
 
auto users (rcComm_t &conn, const group &group) -> std::vector< user >
 
auto groups (rcComm_t &conn) -> std::vector< group >
 
auto groups (rcComm_t &conn, const user &user) -> std::vector< group >
 
auto exists (rcComm_t &conn, const user &user) -> bool
 
auto exists (rcComm_t &conn, const group &group) -> bool
 
auto id (rcComm_t &conn, const user &user) -> std::optional< std::string >
 
auto id (rcComm_t &conn, const group &group) -> std::optional< std::string >
 
auto type (rcComm_t &conn, const user &user) -> std::optional< user_type >
 
auto auth_names (rcComm_t &conn, const user &user) -> std::vector< std::string >
 
auto user_is_member_of_group (rcComm_t &conn, const group &group, const user &user) -> bool
 
auto local_unique_name (rcComm_t &conn, const user &user) -> std::string
 

Function Documentation

◆ add_group()

auto irods::experimental::administration::client::v1::add_group ( rcComm_t conn,
const group group 
) -> std::error_code

◆ add_user()

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

Definition at line 102 of file user_administration.cpp.

References generalAdminInp_t::arg0, local_unique_name(), generate_iadmin_commands_for_41_to_42_upgrade::name, and rxGeneralAdmin.

Here is the call graph for this function:

◆ add_user_auth()

auto irods::experimental::administration::client::v1::add_user_auth ( rcComm_t conn,
const user user,
std::string_view  auth 
) -> std::error_code

Definition at line 181 of file user_administration.cpp.

References generalAdminInp_t::arg0, local_unique_name(), generate_iadmin_commands_for_41_to_42_upgrade::name, and rxGeneralAdmin.

Here is the call graph for this function:

◆ add_user_to_group()

auto irods::experimental::administration::client::v1::add_user_to_group ( rcComm_t conn,
const group group,
const user user 
) -> std::error_code

◆ auth_names()

auto irods::experimental::administration::client::v1::auth_names ( rcComm_t conn,
const user user 
) -> std::vector<std::string>

Definition at line 432 of file user_administration.cpp.

References local_unique_name(), and irods::experimental::administration::v1::user::zone.

Here is the call graph for this function:

◆ exists() [1/2]

auto irods::experimental::administration::client::v1::exists ( rcComm_t conn,
const group group 
) -> bool

◆ exists() [2/2]

auto irods::experimental::administration::client::v1::exists ( rcComm_t conn,
const user user 
) -> bool

Definition at line 359 of file user_administration.cpp.

References irods::experimental::administration::v1::user::name, and irods::experimental::administration::v1::user::zone.

Referenced by _bulkRegUnbunSubfiles(), bulkProcAndRegSubfile(), bundle_cache_dir(), irods::environment_properties::capture(), chkConnectedAgentProcQue(), chkOrphanDir(), convert_server_config(), convert_service_account(), irods::experimental::filesystem::client::copy(), irods::experimental::filesystem::client::copy_data_object(), irods::experimental::filesystem::client::create_collection(), irods::experimental::filesystem::client::create_collections(), createBunDirForBulkPut(), irods::experimental::filesystem::collection_entry::exists(), irods::plugin_name_generator::exists(), irods::experimental::filesystem::client::exists(), fsckObj(), irods::get_full_path_for_config_file(), irods::get_full_path_for_unmoved_configs(), getDirSizeForProgStat(), getFileSize(), getFileType(), getNumFilesInDir(), getPhyBunDir(), irods::init_api_table(), irods::is_path_valid_for_recursion(), isPath(), irods::plugin_name_generator::list_plugins(), irods::load_plugin(), load_version_file(), localProcStat(), lsUtil(), mkdirR(), msi_update_unixfilesystem_resource_free_space(), obfRmPw(), openRestartFile(), putDirUtil(), readLfRestartFile(), regPhySubFile(), regSubfile(), regUnbunPhySubfiles(), regUnbunSubfiles(), irods::experimental::filesystem::client::rename(), irods::resolve_plugin_path(), rmdirCollUtil(), rmFilesInDir(), rmLinkedFilesInUnixDir(), rmSubDir(), rsyncDirToCollUtil(), scanObj(), setStateForResume(), and stat_vault_path().

◆ groups() [1/2]

auto irods::experimental::administration::client::v1::groups ( rcComm_t conn) -> std::vector<group>

Definition at line 317 of file user_administration.cpp.

Referenced by groups().

◆ groups() [2/2]

auto irods::experimental::administration::client::v1::groups ( rcComm_t conn,
const user user 
) -> std::vector<group>

Definition at line 328 of file user_administration.cpp.

References irods::experimental::query_builder::build(), irods::experimental::general, groups(), local_unique_name(), irods::experimental::filesystem::client::move(), irods::experimental::query_builder::type(), user_is_member_of_group(), and irods::experimental::administration::v1::user::zone.

Here is the call graph for this function:

◆ id() [1/2]

auto irods::experimental::administration::client::v1::id ( rcComm_t conn,
const group group 
) -> std::optional<std::string>

◆ id() [2/2]

auto irods::experimental::administration::client::v1::id ( rcComm_t conn,
const user user 
) -> std::optional<std::string>

Definition at line 389 of file user_administration.cpp.

References local_unique_name(), and irods::experimental::administration::v1::user::zone.

Here is the call graph for this function:

◆ local_unique_name()

◆ remove_group()

auto irods::experimental::administration::client::v1::remove_group ( rcComm_t conn,
const group group 
) -> std::error_code

◆ remove_user()

auto irods::experimental::administration::client::v1::remove_user ( rcComm_t conn,
const user user 
) -> std::error_code

Definition at line 128 of file user_administration.cpp.

References generalAdminInp_t::arg0, local_unique_name(), generate_iadmin_commands_for_41_to_42_upgrade::name, rxGeneralAdmin, and irods::experimental::administration::v1::user::zone.

Here is the call graph for this function:

◆ remove_user_auth()

auto irods::experimental::administration::client::v1::remove_user_auth ( rcComm_t conn,
const user user,
std::string_view  auth 
) -> std::error_code

Definition at line 199 of file user_administration.cpp.

References generalAdminInp_t::arg0, local_unique_name(), generate_iadmin_commands_for_41_to_42_upgrade::name, and rxGeneralAdmin.

Here is the call graph for this function:

◆ remove_user_from_group()

auto irods::experimental::administration::client::v1::remove_user_from_group ( rcComm_t conn,
const group group,
const user user 
) -> std::error_code

◆ set_user_password()

auto irods::experimental::administration::client::v1::set_user_password ( rcComm_t conn,
const user user,
std::string_view  new_password 
) -> std::error_code

◆ set_user_type()

auto irods::experimental::administration::client::v1::set_user_type ( rcComm_t conn,
const user user,
user_type  new_user_type 
) -> std::error_code

Definition at line 163 of file user_administration.cpp.

References generalAdminInp_t::arg0, local_unique_name(), generate_iadmin_commands_for_41_to_42_upgrade::name, and rxGeneralAdmin.

Here is the call graph for this function:

◆ type()

auto irods::experimental::administration::client::v1::type ( rcComm_t conn,
const user user 
) -> std::optional<user_type>

Definition at line 417 of file user_administration.cpp.

References local_unique_name(), and irods::experimental::administration::v1::user::zone.

Here is the call graph for this function:

◆ user_is_member_of_group()

auto irods::experimental::administration::client::v1::user_is_member_of_group ( rcComm_t conn,
const group group,
const user user 
) -> bool

Definition at line 449 of file user_administration.cpp.

References local_unique_name(), irods::experimental::administration::v1::group::name, and irods::experimental::administration::v1::user::zone.

Referenced by groups().

Here is the call graph for this function:

◆ users() [1/2]

auto irods::experimental::administration::client::v1::users ( rcComm_t conn) -> std::vector<user>

Definition at line 290 of file user_administration.cpp.

Referenced by users().

◆ users() [2/2]

auto irods::experimental::administration::client::v1::users ( rcComm_t conn,
const group group 
) -> std::vector<user>

Definition at line 301 of file user_administration.cpp.

References irods::experimental::administration::v1::group::name, and users().

Here is the call graph for this function: