Skip to content

Commit f40b834

Browse files
authored
Merge pull request #919 from redis/DOC-4652
RC: Logs viewer role
2 parents 4689770 + 1abfaa2 commit f40b834

File tree

5 files changed

+46
-18
lines changed

5 files changed

+46
-18
lines changed

content/operate/rc/api/get-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ User keys are personal secrets. Do not share them.
5353
{{< /note >}}
5454

5555
Individual owners can [generate multiple user keys]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}})
56-
for themselves, for separate apps, or for other owners within the same account.
56+
for themselves, for separate apps, or for other owners, viewers, or log viewers within the same account.
5757

5858
Use key names to uniquely associate specific API requests to individual users or apps.
5959

content/operate/rc/api/get-started/enable-the-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To enable the API:
3131

3232
To authenticate REST API calls, you need to combine the API account key with an [API user key]({{< relref "/operate/rc/api/get-started/manage-api-keys#api-user-keys" >}}) to make API calls.
3333

34-
Only account owners can see the access key in the account settings.
34+
Only account owners can see the access key in the account settings and give API access to other users.
3535

3636
{{< warning >}}
3737
Make sure that you keep your access keys secret. Anyone who sends an API request with a valid access key can make changes to your account.

content/operate/rc/api/get-started/manage-api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The key name:
6262
- Must be between 10 and 50 characters long
6363
- Can contain alphanumeric characters, hyphens, and underscores. Spaces are not allowed.
6464

65-
The user name must have an owner or viewer role.
65+
The user name must have an owner, viewer, or logs viewer role.
6666

6767
Select **Create** to create the new key.
6868

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
Title: Redis Cloud changelog (December 2024)
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rc
8+
description: New features, enhancements, and other changes added to Redis Cloud during
9+
December 2024.
10+
highlights: Logs Viewer API role
11+
linktitle: December 2024
12+
weight: 38
13+
---
14+
15+
## New features
16+
17+
### Logs Viewer role
18+
19+
You can now add a user with the **Logs Viewer** role in the [Access Management]({{< relref "/operate/rc/security/access-control/access-management" >}}) screen. Logs Viewers can only use the [Redis Cloud API]({{< relref "/operate/rc/api" >}}) [`GET logs/`](https://api.redislabs.com/v1/swagger-ui/index.html#/Account/getAccountSystemLogs) endpoint.
20+
21+
See [Team Management roles]({{< relref "/operate/rc/security/access-control/access-management#team-management-roles" >}}) to see an overview of user roles and their permissions.

content/operate/rc/security/access-control/access-management.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -108,24 +108,31 @@ Roles and responsibilities are:
108108

109109
- **Viewer** can view all databases and their configurations, including database secrets.
110110

111-
This table shows each role's ability to perform common tasks using the Redis Cloud console.
112-
113-
| **Task** | **Owner** | **Billing Admin** | **Manager** | **Member** | **Viewer** |
114-
|---|---|---|---|---|---|
115-
| Access management | <span title="Owners can manage account access">&#x2705; Yes</span> | <span title="Billing Admins may not manage account access">&#x274c; No</span> | <span title="Managers may not manage account access">&#x274c; No</span> | <span title="Members may not manage account access">&#x274c; No</span> | <span title="Viewers may not manage account access">&#x274c; No</span> |
116-
| Account settings | <span title="Owners can change account settings">&#x2705; Yes</span> | <span title="Billing Admins can change the billing address in account settings">&#x2705; Yes<sup>[1](#table-note-1)</sup></span> | <span title="Managers may not manage account settings">&#x274c; No</span> | <span title="Members may not manage account settings">&#x274c; No</span> | <span title="Viewers may not manage account settings">&#x274c; No</span> |
117-
| Billing & payments | <span title="Owners can add/remove payment methods and view history">&#x2705; Yes</span> | <span title="Billing Admins can add/remove payment methods and view history">&#x2705; Yes</span> | <span title="Managers may not add/remove payment methods or view billing history (Managers may change subscription payment methods between those available to the account)">&#x274c; No</span> | <span title="Members may not add/remove payment methods or view billing history">&#x274c; No</span> | <span title="Viewers may not add/remove payment methods or view billing history">&#x274c; No</span> |
118-
| Create subscription | <span title="Owners can create new subscriptions">&#x2705; Yes</span> | <span title="Billing Admins may not create subscriptions">&#x274c; No</span> | <span title="Managers can create new subscriptions">&#x2705; Yes</span> | <span title="Members may not create subscriptions">&#x274c; No</span> | <span title="Viewers may not create subscriptions">&#x274c; No</span> |
119-
| Edit subscription | <span title="Owners can edit subscriptions">&#x2705; Yes</span> | <span title="Billing Admins can edit subscriptions to change the payment method">&#x2705; Yes<sup>[2](#table-note-2)</sup></span> | <span title="Managers can edit subscriptions">&#x2705; Yes</span> | <span title="Members may not edit subscriptions">&#x274c; No</span> | <span title="Viewers may not edit subscriptions">&#x274c; No</span> |
120-
| Create database (affects cost) | <span title="Owners can create databases when doing so will impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not create databases when doing so will impact costs">&#x274c; No</span> | <span title="Managers can create databases when doing so will impact costs">&#x2705; Yes</span> | <span title="Members may not create databases when doing so will impact costs">&#x274c; No</span> | <span title="Viewers may not create databases when doing so will impact costs">&#x274c; No</span> |
121-
| Edit database (affects cost) | <span title="Owners can edit databases in ways that will impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not edit databases in ways that impact costs">&#x274c; No</span> | <span title="Managers can edit databases in ways that impact costs">&#x2705; Yes</span> | <span title="Members may not edit databases in ways that impact costs">&#x274c; No</span> | <span title="Viewers may not edit databases in ways that impact costs">&#x274c; No</span> |
122-
| Create database (no cost impact) | <span title="Owners can create databases when doing so will not impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not create databases when doing so will not impact costs">&#x274c; No</span> | <span title="Managers can create databases when doing so will not impact costs">&#x2705; Yes</span> | <span title="Members can create databases when doing so will not impact costs">&#x2705; Yes</span> | <span title="Viewers may not create databases when doing so will not impact costs">&#x274c; No</span> |
123-
| Edit database (no cost impact) | <span title="Owners can edit databases in ways that do not impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not change databases in ways that do not affect costs">&#x274c; No</span> | <span title="Managers can change databases in ways that do not affect costs">&#x2705; Yes</span> | <span title="Members can change databases in ways that do not affect costs">&#x2705; Yes</span> | <span title="Viewers may not change databases in ways that do not affect costs">&#x274c; No</span> |
124-
| View subscription | <span title="Owners can view subscription details">&#x2705; Yes</span> | <span title="Billing Admins can view subscription details">&#x2705; Yes</span> | <span title="Managers can view subscription details">&#x2705; Yes</span> | <span title="Members can view subscription details">&#x2705; Yes</span> | <span title="Viewers can view subscription details">&#x2705; Yes</span> |
125-
| View database | <span title="Owners can view database details">&#x2705; Yes</span> | <span title="Billing Admins can view the list of databases but not database details">&#x2705; Yes<sup>[3](#table-note-3)</sup></span> | <span title="Managers can view database details">&#x2705; Yes</span> | <span title="Members can view database details">&#x2705; Yes</span> | <span title="Viewers can view database details">&#x2705; Yes</span> |
111+
- **Logs viewer** can not access the Redis Cloud console. They are only allowed access to the [Redis Cloud API]({{< relref "/operate/rc/api" >}}) [`GET logs/`](https://api.redislabs.com/v1/swagger-ui/index.html#/Account/getAccountSystemLogs) endpoint.
112+
113+
This table shows each role's ability to perform common tasks.
114+
115+
| **Task** | **Owner** | **Billing Admin** | **Manager** | **Member** | **Viewer** | **Logs Viewer** |
116+
|---|---|---|---|---|---|---|
117+
| Access management | <span title="Owners can manage account access">&#x2705; Yes</span> | <span title="Billing Admins may not manage account access">&#x274c; No</span> | <span title="Managers may not manage account access">&#x274c; No</span> | <span title="Members may not manage account access">&#x274c; No</span> | <span title="Viewers may not manage account access">&#x274c; No</span> | <span title="Logs Viewers may not manage account access">&#x274c; No</span> |
118+
| Account settings | <span title="Owners can change account settings">&#x2705; Yes</span> | <span title="Billing Admins can change the billing address in account settings">&#x2705; Yes<sup>[1](#table-note-1)</sup></span> | <span title="Managers may not manage account settings">&#x274c; No</span> | <span title="Members may not manage account settings">&#x274c; No</span> | <span title="Viewers may not manage account settings">&#x274c; No</span> | <span title="Logs Viewers may not manage account settings">&#x274c; No</span> |
119+
| Billing & payments | <span title="Owners can add/remove payment methods and view history">&#x2705; Yes</span> | <span title="Billing Admins can add/remove payment methods and view history">&#x2705; Yes</span> | <span title="Managers may not add/remove payment methods or view billing history (Managers may change subscription payment methods between those available to the account)">&#x274c; No</span> | <span title="Members may not add/remove payment methods or view billing history">&#x274c; No</span> | <span title="Viewers may not add/remove payment methods or view billing history">&#x274c; No</span> | <span title="Logs viewers may not add/remove payment methods or view billing history">&#x274c; No</span> |
120+
| Create subscription | <span title="Owners can create new subscriptions">&#x2705; Yes</span> | <span title="Billing Admins may not create subscriptions">&#x274c; No</span> | <span title="Managers can create new subscriptions">&#x2705; Yes</span> | <span title="Members may not create subscriptions">&#x274c; No</span> | <span title="Viewers may not create subscriptions">&#x274c; No</span> | <span title="Logs viewers may not create subscriptions">&#x274c; No</span> |
121+
| Edit subscription | <span title="Owners can edit subscriptions">&#x2705; Yes</span> | <span title="Billing Admins can edit subscriptions to change the payment method">&#x2705; Yes<sup>[2](#table-note-2)</sup></span> | <span title="Managers can edit subscriptions">&#x2705; Yes</span> | <span title="Members may not edit subscriptions">&#x274c; No</span> | <span title="Viewers may not edit subscriptions">&#x274c; No</span> | <span title="Logs viewers may not edit subscriptions">&#x274c; No</span> |
122+
| Create database (affects cost) | <span title="Owners can create databases when doing so will impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not create databases when doing so will impact costs">&#x274c; No</span> | <span title="Managers can create databases when doing so will impact costs">&#x2705; Yes</span> | <span title="Members may not create databases when doing so will impact costs">&#x274c; No</span> | <span title="Viewers may not create databases when doing so will impact costs">&#x274c; No</span> | <span title="Logs viewers may not create databases when doing so will impact costs">&#x274c; No</span> |
123+
| Edit database (affects cost) | <span title="Owners can edit databases in ways that will impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not edit databases in ways that impact costs">&#x274c; No</span> | <span title="Managers can edit databases in ways that impact costs">&#x2705; Yes</span> | <span title="Members may not edit databases in ways that impact costs">&#x274c; No</span> | <span title="Viewers may not edit databases in ways that impact costs">&#x274c; No</span> | <span title="Logs viewers may not edit databases in ways that impact costs">&#x274c; No</span> |
124+
| Create database (no cost impact) | <span title="Owners can create databases when doing so will not impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not create databases when doing so will not impact costs">&#x274c; No</span> | <span title="Managers can create databases when doing so will not impact costs">&#x2705; Yes</span> | <span title="Members can create databases when doing so will not impact costs">&#x2705; Yes</span> | <span title="Viewers may not create databases when doing so will not impact costs">&#x274c; No</span> | <span title="Logs viewers may not create databases when doing so will not impact costs">&#x274c; No</span> |
125+
| Edit database (no cost impact) | <span title="Owners can edit databases in ways that do not impact costs">&#x2705; Yes</span> | <span title="Billing Admins may not change databases in ways that do not affect costs">&#x274c; No</span> | <span title="Managers can change databases in ways that do not affect costs">&#x2705; Yes</span> | <span title="Members can change databases in ways that do not affect costs">&#x2705; Yes</span> | <span title="Viewers may not change databases in ways that do not affect costs">&#x274c; No</span> | <span title="Logs viewers may not change databases in ways that do not affect costs">&#x274c; No</span> |
126+
| View subscription | <span title="Owners can view subscription details">&#x2705; Yes</span> | <span title="Billing Admins can view subscription details">&#x2705; Yes</span> | <span title="Managers can view subscription details">&#x2705; Yes</span> | <span title="Members can view subscription details">&#x2705; Yes</span> | <span title="Viewers can view subscription details">&#x2705; Yes</span> | <span title="Logs viewers may not view subscriptions">&#x274c; No</span> |
127+
| View database | <span title="Owners can view database details">&#x2705; Yes</span> | <span title="Billing Admins can view the list of databases but not database details">&#x2705; Yes<sup>[3](#table-note-3)</sup></span> | <span title="Managers can view database details">&#x2705; Yes</span> | <span title="Members can view database details">&#x2705; Yes</span> | <span title="Viewers can view database details">&#x2705; Yes</span> | <span title="Logs viewers may not view databases">&#x274c; No</span> |
128+
| Use the [REST API]({{< relref "/operate/rc/api" >}}) | <span title="Owners can use the Redis Cloud API">&#x2705; Yes</span> | <span title="Billing Admins may not use the Redis Cloud API">&#x274c; No</span> | <span title="Managers may not use the REST API">&#x274c; No</span> | <span title="Members may not use the REST API">&#x274c; No</span> | <span title="Viewers can use the REST API for GET requests only">&#x2705; Yes<sup>[4](#table-note-4)</sup></span> | <span title="Logs viewers can use the REST API for GET /logs only">&#x2705; Yes<sup>[5](#table-note-5)</sup></span> |
126129

127130
1. <a name="table-note-1" style="display: block; height: 80px; margin-top: -80px;"></a>Billing Admins can only edit the account billing address in Account Settings.
128131

129132
2. <a name="table-note-2" style="display: block; height: 80px; margin-top: -80px;"></a>Billing Admins can only change the payment method when editing a subscription.
130133

131134
3. <a name="table-note-3" style="display: block; height: 80px; margin-top: -80px;"></a>Billing Admins can see the list of databases, but can not see database details, including connection details.
135+
136+
4. <a name="table-note-4" style="display: block; height: 80px; margin-top: -80px;"></a>Viewers can use the REST API for GET requests, but can not modify subscription or database details.
137+
138+
5. <a name="table-note-5" style="display: block; height: 80px; margin-top: -80px;"></a>Logs viewers can only use the [`GET logs/`](https://api.redislabs.com/v1/swagger-ui/index.html#/Account/getAccountSystemLogs) endpoint of the REST API.

0 commit comments

Comments
 (0)