Create roles with combined access

Create roles with both cluster and database access.

To create a role that grants database access privileges and allows access to the Cluster Management UI and REST API:

1. Define Redis ACLs that determine database access privileges.

2. Create a role with ACLs added and choose a Cluster management role other than None.

Define Redis ACLs

You can use the Cluster Manager UI or the REST API to define Redis ACL rules that you can assign to roles.

Cluster Manager UI method

To define a Redis ACL rule using the Cluster Manager UI:

1. From Access Control > Redis ACLs, you can either:

   • Point to a Redis ACL and select to edit an existing Redis ACL.

   • Select + Add Redis ACL to create a new Redis ACL.

2. Enter a descriptive name for the Redis ACL. This will be used to associate the ACL rule with the role.

3. Define the ACL rule. For more information about Redis ACL rules and syntax, see the Redis ACL overview.

   Note:

   The ACL builder does not support selectors and key permissions. Use Free text command to manually define them instead.

4. Select Save.

REST API method

To define a Redis ACL rule using the REST API, use a create Redis ACL request. For more information about Redis ACL rules and syntax, see the Redis ACL overview.

Example request:

POST /v1/redis_acls
{ 
  "name": "Test_ACL_1",
  "acl": "+@read +FT.INFO +FT.SEARCH"
}

Example response body:

{ 
  "acl": "+@read +FT.INFO +FT.SEARCH",
  "name": "Test_ACL_1",
  "uid": 11
}

To associate the Redis ACL with a role and database, use the uid from the response as the redis_acl_uid when you add roles_permissions to the database. See Associate a database with roles and Redis ACLs for an example request.

Create roles with ACLs and cluster access

You can create a role that grants database access privileges and allows access to the Cluster Management UI and REST API.

Cluster Manager UI method

To define a role for combined access using the Cluster Manager UI:

1. From Access Control > Roles, you can:

   • Point to a role and select to edit an existing role.

   • Select + Add role to create a new role.

   

2. Enter a descriptive name for the role. This will be used to reference the role when configuring users.

3. Choose a Cluster management role other than None. For details about permissions granted by each role, see Cluster Manager UI permissions and REST API permissions.

   

4. Select + Add ACL.

   

5. Choose a Redis ACL and databases to associate with the role.

   

6. Select the check mark to confirm.

7. Select Save.

   

You can assign the new role to users to grant database access and access to the Cluster Manager UI and REST API.

REST API method

To define a role for combined access using the REST API:

1. Create a role.

2. Associate a database with roles and Redis ACLs.

Create a role

To create a role using the REST API:

POST /v1/roles
{ 
  "name": "<role-name>",
  "management": "db_viewer | db_member | cluster_viewer | cluster_member | admin" 
}

Example response body:

{ 
  "management": "admin",
  "name": "<role-name>",
  "uid": 7
}

To associate the role with a Redis ACL and database, use the uid from the response as the role_uid when you add roles_permissions to the database. See Associate a database with roles and Redis ACLs for an example request.

Associate a database with roles and Redis ACLs

Update a database's configuration to add roles_permissions with the role and Redis ACL:

POST /v1/bdbs/<database-id>
{
  "roles_permissions":
  [
    {
      "role_uid": <integer>,
      "redis_acl_uid": <integer>
    }
  ]
}