Role manager interface.
More...
|
constant int | ERR_ROLE_ALREADY_EXISTS = 1 |
| A role with that name already exists.
|
|
constant int | ERR_MAX_ROLES_REACHED = 2 |
| Maximum number of roles reached.
|
|
constant int | ERR_INVALID_VALUE = 3 |
| Invalid arguments.
|
|
constant int | ERR_ROLE_DOESNT_EXIST = 1 |
| The role does not exist.
|
|
constant int | ERR_ROLE_NOT_DELETABLE = 2 |
| The role cannot be deleted.
|
|
◆ createRoleFull()
int usermgmt::RoleManager::createRoleFull |
( |
in string |
name, |
|
|
in Role::Info |
info |
|
) |
| |
Create new role with full information.
- Parameters
-
name | New role name |
info | New role information |
- Returns
- 0 if OK
-
1 if a role with that name already exists
-
2 if the maximum number of roles is reached
-
3 if the role information is invalid
◆ deleteRole()
int usermgmt::RoleManager::deleteRole |
( |
in string |
name | ) |
|
Delete a role.
- Parameters
-
name | Name of the role to delete |
- Returns
- 0 if OK
-
1 if a role with the given name does not exist
-
2 if the role cannot be deleted
◆ getAllPrivileges()
vector< PrivilegeDesc > usermgmt::RoleManager::getAllPrivileges |
( |
| ) |
|
Retrieve a list of supported privileges.
- Returns
- List of privilege names
◆ getAllRoleNames()
vector< string > usermgmt::RoleManager::getAllRoleNames |
( |
| ) |
|
Retrieve a list of role names.
- Returns
- List of role names
◆ getAllRoles()
vector< RoleAccount > usermgmt::RoleManager::getAllRoles |
( |
| ) |
|
Retrieve a list of active roles.
- Returns
- List of active roles
◆ getInfo()
Info usermgmt::RoleManager::getInfo |
( |
| ) |
|
Retrieve full role manager information.
- Returns
- Role manager information
The documentation for this interface was generated from the following file: