Back to Redis

Create Combined Roles

content/operate/rs/7.22/security/access-control/create-combined-roles.md

latest4.7 KB
Original Source

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 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.

{{< multitabs id="define-redis-acls" tab1="Cluster Manager UI" tab2="REST API" >}}

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

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

    • Select an existing Redis ACL from the list to edit it.

    • Click + 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]({{<relref "/operate/rs/7.22/security/access-control/redis-acl-overview">}}).

  4. Click Save.

-tab-sep-

To define a Redis ACL rule using the REST API, use a [create Redis ACL]({{<relref "/operate/rs/7.22/references/rest-api/requests/redis_acls#post-redis_acl">}}) request. For more information about Redis ACL rules and syntax, see the [Redis ACL overview]({{<relref "/operate/rs/7.22/security/access-control/redis-acl-overview">}}).

Example request:

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

Example response body:

json
{ 
  "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.

{{< /multitabs >}}

{{<note>}} For multi-key commands on multi-slot keys, the return value is failure, but the command runs on the keys that are allowed. {{</note>}}

Create roles with ACLs and cluster access {#create-role}

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

{{< multitabs id="create-combined-roles" tab1="Cluster Manager UI" tab2="REST API" >}}

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

  1. From Access Control > Roles, you can:

    • Select a role from the list of existing roles to edit it.

    • Click + 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 Management role other than None. For details about permissions granted by each role, see [Cluster Manager UI permissions]({{<relref "/operate/rs/7.22/security/access-control/create-cluster-roles#cluster-manager-ui-permissions">}}) and [REST API permissions]({{<relref "/operate/rs/7.22/references/rest-api/permissions">}}).

  4. Click + Add ACL.

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

  6. Click the check mark to confirm.

  7. Click Save.

-tab-sep-

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

  1. Use a [create role]({{<relref "/operate/rs/7.22/references/rest-api/requests/roles#post-role">}}) request:

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

    Example response body:

    json
    { 
      "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.

  2. [Update a database's configuration]({{<relref "/operate/rs/7.22/references/rest-api/requests/bdbs#put-bdbs">}}) to add roles_permissions with the role and Redis ACL:

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

{{< /multitabs >}}

You can [assign the new role to users]({{<relref "/operate/rs/7.22/security/access-control/create-users#assign-roles-to-users">}}) to grant database access and access to the Cluster Manager UI and REST API.