Some Redis Enterprise REST API requests may require the user to have specific permissions.

Administrators can assign a predefined role to a user via the admin console or a PUT /users/{uid} API request in order to grant necessary permissions to them.

Roles

Each user in the cluster has an assigned cluster management role, which defines the permissions granted to the user.

Available management roles include:

  • none: No REST API permissions.
  • db_viewer: Can view database info.
  • db_member: Can create or modify databases and view their info.
  • cluster_viewer: Can view cluster and database info.
  • cluster_member: Can modify the cluster and databases and view their info.
  • admin: Can view and modify all elements of the cluster.

Permissions list for each role

RolePermissions
noneNo permissions
adminadd_cluster_module, cancel_cluster_action, cancel_node_action, config_ldap, config_ocsp, create_bdb, create_crdb, create_ldap_mapping, create_new_user, create_redis_acl, create_role, delete_bdb, delete_cluster_module, delete_crdb, delete_ldap_mapping, delete_redis_acl, delete_role, delete_user, edit_bdb_module, flush_crdb, install_new_license, migrate_shard, purge_instance, reset_bdb_current_backup_status, reset_bdb_current_export_status, reset_bdb_current_import_status, start_bdb_export, start_bdb_import, start_cluster_action, start_node_action, test_ocsp_status, update_bdb, update_bdb_alerts, update_bdb_with_action, update_cluster, update_crdb, update_ldap_mapping, update_node, update_proxy, update_redis_acl, update_role, update_user, view_all_bdb_stats, view_all_bdbs_alerts, view_all_bdbs_info, view_all_ldap_mappings_info, view_all_nodes_alerts, view_all_nodes_checks, view_all_nodes_info, view_all_nodes_stats, view_all_proxies_info, view_all_redis_acls_info, view_all_roles_info, view_all_shard_stats, view_all_users_info, view_bdb_alerts, view_bdb_info, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_keys, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_debugging_info, view_endpoint_stats, view_ldap_config, view_ldap_mapping_info, view_license, view_logged_events, view_node_alerts, view_node_check, view_node_info, view_node_stats, view_ocsp_config, view_ocsp_status, view_proxy_info, view_redis_acl_info, view_redis_pass, view_role_info, view_shard_stats, view_status_of_all_node_actions, view_status_of_cluster_action, view_status_of_node_action, view_user_info
cluster_membercreate_bdb, create_crdb, delete_bdb, delete_crdb, edit_bdb_module, flush_crdb, migrate_shard, purge_instance, reset_bdb_current_backup_status, reset_bdb_current_export_status, reset_bdb_current_import_status, start_bdb_export, start_bdb_import, update_bdb, update_bdb_alerts, update_bdb_with_action, update_crdb, view_all_bdb_stats, view_all_bdbs_alerts, view_all_bdbs_info, view_all_nodes_alerts, view_all_nodes_checks, view_all_nodes_info, view_all_nodes_stats, view_all_proxies_info, view_all_redis_acls_info, view_all_roles_info, view_all_shard_stats, view_bdb_alerts, view_bdb_info, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_keys, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_debugging_info, view_endpoint_stats, view_license, view_logged_events, view_node_alerts, view_node_check, view_node_info, view_node_stats, view_proxy_info, view_redis_acl_info, view_redis_pass, view_role_info, view_shard_stats, view_status_of_all_node_actions, view_status_of_cluster_action, view_status_of_node_action
cluster_viewerview_all_bdb_stats, view_all_bdbs_alerts, view_all_bdbs_info, view_all_nodes_alerts, view_all_nodes_checks, view_all_nodes_info, view_all_nodes_stats, view_all_proxies_info, view_all_redis_acls_info, view_all_roles_info, view_all_shard_stats, view_bdb_alerts, view_bdb_info, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_endpoint_stats, view_license, view_logged_events, view_node_alerts, view_node_check, view_node_info, view_node_stats, view_proxy_info, view_redis_acl_info, view_role_info, view_shard_stats, view_status_of_all_node_actions, view_status_of_cluster_action, view_status_of_node_action
db_membercreate_bdb, create_crdb, delete_bdb, delete_crdb, edit_bdb_module, flush_crdb, migrate_shard, purge_instance, reset_bdb_current_backup_status, reset_bdb_current_export_status, reset_bdb_current_import_status, start_bdb_export, start_bdb_import, update_bdb, update_bdb_alerts, update_bdb_with_action, update_crdb, view_all_bdb_stats, view_all_bdbs_alerts, view_all_bdbs_info, view_all_nodes_alerts, view_all_nodes_checks, view_all_nodes_info, view_all_nodes_stats, view_all_proxies_info, view_all_redis_acls_info, view_all_roles_info, view_all_shard_stats, view_bdb_alerts, view_bdb_info, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_debugging_info, view_endpoint_stats, view_license, view_logged_events, view_node_alerts, view_node_check, view_node_info, view_node_stats, view_proxy_info, view_redis_acl_info, view_redis_pass, view_role_info, view_shard_stats, view_status_of_all_node_actions, view_status_of_cluster_action, view_status_of_node_action
db_viewerview_all_bdb_stats, view_all_bdbs_alerts, view_all_bdbs_info, view_all_nodes_alerts, view_all_nodes_checks, view_all_nodes_info, view_all_nodes_stats, view_all_proxies_info, view_all_redis_acls_info, view_all_roles_info, view_all_shard_stats, view_bdb_alerts, view_bdb_info, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_endpoint_stats, view_license, view_node_alerts, view_node_check, view_node_info, view_node_stats, view_proxy_info, view_redis_acl_info, view_role_info, view_shard_stats, view_status_of_all_node_actions, view_status_of_cluster_action, view_status_of_node_action

Roles list per permission

PermissionRoles
add_cluster_moduleadmin
cancel_cluster_actionadmin
cancel_node_actionadmin
config_ldapadmin
config_ocspadmin
create_bdbadmin
cluster_member
db_member
create_crdbadmin
cluster_member
db_member
create_ldap_mappingadmin
create_new_useradmin
create_redis_acladmin
create_roleadmin
delete_bdbadmin
cluster_member
db_member
delete_cluster_moduleadmin
delete_crdbadmin
cluster_member
db_member
delete_ldap_mappingadmin
delete_redis_acladmin
delete_roleadmin
delete_useradmin
edit_bdb_moduleadmin
cluster_member
db_member
flush_crdbadmin
cluster_member
db_member
install_new_licenseadmin
migrate_shardadmin
cluster_member
db_member
purge_instanceadmin
cluster_member
db_member
reset_bdb_current_backup_statusadmin
cluster_member
db_member
reset_bdb_current_export_statusadmin
cluster_member
db_member
reset_bdb_current_import_statusadmin
cluster_member
db_member
start_bdb_exportadmin
cluster_member
db_member
start_bdb_importadmin
cluster_member
db_member
start_cluster_actionadmin
start_node_actionadmin
test_ocsp_statusadmin
update_bdbadmin
cluster_member
db_member
update_bdb_alertsadmin
cluster_member
db_member
update_bdb_with_actionadmin
cluster_member
db_member
update_clusteradmin
update_crdbadmin
cluster_member
db_member
update_ldap_mappingadmin
update_nodeadmin
update_proxyadmin
update_redis_acladmin
update_roleadmin
update_useradmin
view_all_bdb_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_bdbs_alertsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_bdbs_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_ldap_mappings_infoadmin
view_all_nodes_alertsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_nodes_checksadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_nodes_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_nodes_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_proxies_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_redis_acls_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_roles_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_shard_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_all_users_infoadmin
view_bdb_alertsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_bdb_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_bdb_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_cluster_alertsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_cluster_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_cluster_keysadmin
cluster_member
view_cluster_modulesadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_cluster_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_crdbadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_crdb_listadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_debugging_infoadmin
cluster_member
db_member
view_endpoint_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_ldap_configadmin
view_ldap_mapping_infoadmin
view_licenseadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_logged_eventsadmin
cluster_member
cluster_viewer
db_member
view_node_alertsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_node_checkadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_node_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_node_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_ocsp_configadmin
view_ocsp_statusadmin
view_proxy_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_redis_acl_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_redis_passadmin
cluster_member
db_member
view_role_infoadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_shard_statsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_status_of_all_node_actionsadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_status_of_cluster_actionadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_status_of_node_actionadmin
cluster_member
cluster_viewer
db_member
db_viewer
view_user_infoadmin