{
  "id": "redis_enterprise_cluster_role_api",
  "title": "RedisEnterpriseClusterRole API Reference",
  "url": "https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_cluster_role_api/",
  "summary": "",
  "tags": [
    "docs",
    "operate",
    "kubernetes"
  ],
  "last_updated": "2026-07-24T10:52:10-07:00",
  "page_type": "content",
  "content_hash": "2ee43f7661916b4cd9ce1ee016c3dec80bd2bc6cd581741a17ea379f855c5c23",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "apiVersion:\n\n\n- [app.redislabs.com/v1alpha1](#appredislabscomv1alpha1)\n\n\n\n\n# app.redislabs.com/v1alpha1\n\n\n\n\nRedisEnterpriseClusterRole is a cluster role definition. It grants users cluster-scoped access across the Redis Enterprise Cluster.\n\n<table>\n    <thead>\n        <tr>\n            <th>Name</th>\n            <th>Type</th>\n            <th>Description</th>\n            <th>Required</th>\n        </tr>\n    </thead>\n    <tbody><tr>\n      <td>apiVersion</td>\n      <td>string</td>\n      <td>app.redislabs.com/v1alpha1</td>\n      <td>true</td>\n      </tr>\n      <tr>\n      <td>kind</td>\n      <td>string</td>\n      <td>RedisEnterpriseClusterRole</td>\n      <td>true</td>\n      </tr>\n      <tr>\n      <td><a href=\"https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta\">metadata</a></td>\n      <td>object</td>\n      <td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>\n      <td>true</td>\n      </tr><tr>\n        <td><a href=\"#spec\">spec</a></td>\n        <td>object</td>\n        <td>\n          RedisEnterpriseClusterRoleSpec defines the desired state of a RedisEnterpriseClusterRole.<br/>\n        </td>\n        <td>false</td>\n      </tr><tr>\n        <td><a href=\"#status\">status</a></td>\n        <td>object</td>\n        <td>\n          RedisEnterpriseRoleStatus defines the observed state of a Redis Enterprise role object. This status type is used by both RedisEnterpriseClusterRole and RedisEnterpriseRole which share the same status structure.<br/>\n        </td>\n        <td>false</td>\n      </tr></tbody>\n</table>"
    },
    {
      "id": "spec",
      "title": "spec",
      "role": "content",
      "text": "<sup><sup>[↩ Parent](#)</sup></sup>\n\nRedisEnterpriseClusterRoleSpec defines the desired state of a RedisEnterpriseClusterRole.\n\n<table>\n    <thead>\n        <tr>\n            <th>Name</th>\n            <th>Type</th>\n            <th>Description</th>\n            <th>Required</th>\n        </tr>\n    </thead>\n    <tbody><tr>\n        <td><a href=\"#specacl\">acl</a></td>\n        <td>object</td>\n        <td>\n          ACL defines the data access permissions granted by this cluster role.\nUsers with this role can access any database in the Redis Enterprise Cluster,\nsubject to the permissions granted by the referenced ACL.\nReferences a RedisEnterpriseACL (kind RedisEnterpriseACL or empty) or an\ninternal Redis Enterprise ACL by name (kind 'redis_acl').<br/>\n        </td>\n        <td>false</td>\n      </tr><tr>\n        <td>managementRole</td>\n        <td>enum</td>\n        <td>\n          ManagementRole is the named set of Redis Enterprise management permissions assigned to this cluster role. If omitted, the role uses the None management role.<br/>\n          <br/>\n            <i>Enum</i>: Admin, ClusterMember, ClusterViewer, DBMember, DBViewer, UserManager, None<br/>\n        </td>\n        <td>false</td>\n      </tr></tbody>\n</table>"
    },
    {
      "id": "spec-acl",
      "title": "spec.acl",
      "role": "content",
      "text": "<sup><sup>[↩ Parent](#spec)</sup></sup>\n\nACL defines the data access permissions granted by this cluster role.\nUsers with this role can access any database in the Redis Enterprise Cluster,\nsubject to the permissions granted by the referenced ACL.\nReferences a RedisEnterpriseACL (kind RedisEnterpriseACL or empty) or an\ninternal Redis Enterprise ACL by name (kind 'redis_acl').\n\n<table>\n    <thead>\n        <tr>\n            <th>Name</th>\n            <th>Type</th>\n            <th>Description</th>\n            <th>Required</th>\n        </tr>\n    </thead>\n    <tbody><tr>\n        <td>name</td>\n        <td>string</td>\n        <td>\n          Name of the referent.<br/>\n        </td>\n        <td>true</td>\n      </tr><tr>\n        <td>kind</td>\n        <td>enum</td>\n        <td>\n          Kind of the referent.<br/>\n          <br/>\n            <i>Enum</i>: , RedisEnterpriseACL, redis_acl<br/>\n        </td>\n        <td>false</td>\n      </tr></tbody>\n</table>"
    },
    {
      "id": "status",
      "title": "status",
      "role": "content",
      "text": "<sup><sup>[↩ Parent](#)</sup></sup>\n\nRedisEnterpriseRoleStatus defines the observed state of a Redis Enterprise role object. This status type is used by both RedisEnterpriseClusterRole and RedisEnterpriseRole which share the same status structure.\n\n<table>\n    <thead>\n        <tr>\n            <th>Name</th>\n            <th>Type</th>\n            <th>Description</th>\n            <th>Required</th>\n        </tr>\n    </thead>\n    <tbody><tr>\n        <td>observedGeneration</td>\n        <td>integer</td>\n        <td>\n          The most recent generation of this resource that was observed and acted upon by the controller.<br/>\n          <br/>\n            <i>Format</i>: int64<br/>\n        </td>\n        <td>false</td>\n      </tr><tr>\n        <td>uid</td>\n        <td>string</td>\n        <td>\n          The internal UID of the Role object defined in the Redis Enterprise Cluster.<br/>\n        </td>\n        <td>false</td>\n      </tr></tbody>\n</table>"
    }
  ],
  "examples": []
}