Documents the permissions used with Redis Enterprise Software REST API calls.
| Redis Enterprise Software |
|---|
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.
Each user in the cluster has an assigned cluster management role, which defines the permissions granted to the user.
Available management roles include:
| 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 |
| manage_cluster_modules | admin |
| 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_metrics | admin cluster_member cluster_viewer |
| 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 |