Permissions

Documents the permissions used with Redis Enterprise Software REST API calls.

Redis Enterprise Software

This documentation applies to version 7.22.

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

Administrators can assign a predefined role to a user with the Cluster Manager UI or a PUT /v1/users/{uid} API request 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.
user_manager: Can modify users and view their info.
admin: Can view and modify all elements of the cluster.

Permissions list for each role

Role	Permissions
none	No permissions
admin	add_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, failover_shard, 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_bdb_recovery, 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_recovery_plan, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_keys, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_crdb_task, view_crdb_task_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_member	create_bdb, create_crdb, delete_bdb, delete_crdb, edit_bdb_module, failover_shard, 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, start_bdb_recovery, 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_recovery_plan, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_keys, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_crdb_task, view_crdb_task_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_viewer	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_recovery_plan, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_crdb_task, view_crdb_task_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_member	create_bdb, create_crdb, delete_bdb, delete_crdb, edit_bdb_module, failover_shard, 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, start_bdb_recovery, 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_recovery_plan, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_crdb_task, view_crdb_task_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_viewer	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_recovery_plan, view_bdb_stats, view_cluster_alerts, view_cluster_info, view_cluster_modules, view_cluster_stats, view_crdb, view_crdb_list, view_crdb_task, view_crdb_task_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
user_manager	config_ldap, create_ldap_mapping, create_new_user, create_role, create_redis_acl, delete_ldap_mapping, delete_redis_acl, delete_role, delete_user, install_new_license, update_ldap_mapping, update_proxy, update_role, update_redis_acl, 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_crdb_task, view_crdb_task_list, 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_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

Roles list per permission

Permission	Roles
add_cluster_module	admin
cancel_cluster_action	admin
cancel_node_action	admin
config_ldap	admin user_manager
config_ocsp	admin
create_bdb	admin cluster_member db_member
create_crdb	admin cluster_member db_member
create_ldap_mapping	admin user_manager
create_new_user	admin user_manager
create_redis_acl	admin user_manager
create_role	admin user_manager
delete_bdb	admin cluster_member db_member
delete_cluster_module	admin
delete_crdb	admin cluster_member db_member
delete_ldap_mapping	admin user_manager
delete_redis_acl	admin user_manager
delete_role	admin user_manager
delete_user	admin user_manager
edit_bdb_module	admin cluster_member db_member
failover_shard	admin cluster_member db_member
flush_crdb	admin cluster_member db_member
install_new_license	admin user_manager
migrate_shard	admin cluster_member db_member
purge_instance	admin cluster_member db_member
reset_bdb_current_backup_status	admin cluster_member db_member
reset_bdb_current_export_status	admin cluster_member db_member
reset_bdb_current_import_status	admin cluster_member db_member
start_bdb_export	admin cluster_member db_member
start_bdb_import	admin cluster_member db_member
start_bdb_recovery	admin cluster_member db_member
start_cluster_action	admin
start_node_action	admin
test_ocsp_status	admin
update_bdb	admin cluster_member db_member
update_bdb_alerts	admin cluster_member db_member
update_bdb_with_action	admin cluster_member db_member
update_cluster	admin
update_crdb	admin cluster_member db_member
update_ldap_mapping	admin user_manager
update_node	admin
update_proxy	admin user_manager
update_redis_acl	admin user_manager
update_role	admin user_manager
update_user	admin user_manager
view_all_bdb_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_bdbs_alerts	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_bdbs_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_ldap_mappings_info	admin user_manager
view_all_nodes_alerts	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_nodes_checks	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_nodes_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_nodes_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_proxies_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_redis_acls_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_roles_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_shard_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_all_users_info	admin user_manager
view_bdb_alerts	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_bdb_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_bdb_recovery_plan	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_bdb_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_cluster_alerts	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_cluster_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_cluster_keys	admin cluster_member user_manager
view_cluster_modules	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_cluster_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_crdb	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_crdb_list	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_crdb_task	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_crdb_task_list	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_debugging_info	admin cluster_member db_member user_manager
view_endpoint_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_ldap_config	admin user_manager
view_ldap_mapping_info	admin user_manager
view_license	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_logged_events	admin cluster_member cluster_viewer db_member user_manager
view_node_alerts	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_node_check	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_node_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_node_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_ocsp_config	admin
view_ocsp_status	admin
view_proxy_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_redis_acl_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_redis_pass	admin cluster_member db_member user_manager
view_role_info	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_shard_stats	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_status_of_all_node_actions	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_status_of_cluster_action	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_status_of_node_action	admin cluster_member cluster_viewer db_member db_viewer user_manager
view_user_info	admin user_manager

Products

Tools

Get Redis

Connect

Learn

Latest

See how it works

Permissions

Roles

Permissions list for each role

Roles list per permission

On this page