Skip to content

Commit 5ef0d11

Browse files
rrelledgerrelledge
authored
RS: User manager role (#813)
* DOC-4354 RS: Add new user manager role * DOC-4354 Add user_manager role to REST API permissions reference & fix table anchor format * DOC-4354 Add user_manager role to REST API permissions table * Fix table anchor style * 2nd attempt to fix merge conflict * Another fix for merge conflict * DOC-4354 Add user_manager to view_crdb_task REST API permissions * DOC-4354 Add user_manager to RBAC REST API requests * DOC-4354 Add user_manager role to other requests according to listed permissions * DOC-4354 RS: Add user manager role to CM UI permissions table * DOC-4354 Feedback update to remove duplicated page description * DOC-4415 Add missing auth_method options for user API object
1 parent 1e58a23 commit 5ef0d11

File tree

24 files changed

+128
-125
lines changed

24 files changed

+128
-125
lines changed

‎content/operate/rs/references/rest-api/objects/role.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ An API object that represents a role.
1717
| uid | integer | Role's unique ID |
1818
| account_id | integer | SM account ID |
1919
| action_uid | string | Action UID. If it exists, progress can be tracked by the GET /actions/{uid} API (read-only) |
20-
| management | 'admin'<br />'db_member'<br />'db_viewer'<br />'cluster_member'<br />'cluster_viewer'<br />'none' | [Management role]({{< relref "/operate/rs/references/rest-api/permissions#roles" >}}) |
20+
| management | 'admin'<br />'db_member'<br />'db_viewer'<br />'cluster_member'<br />'cluster_viewer'<br />'user_manager'<br />'none' | [Management role]({{< relref "/operate/rs/references/rest-api/permissions#roles" >}}) |
2121
| name | string | Role's name |

‎content/operate/rs/references/rest-api/objects/user.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,17 @@ categories:
55
- docs
66
- operate
77
- rs
8-
description: An object that represents a Redis Enterprise user
8+
description: An API object that represents a Redis Enterprise user
99
linkTitle: user
1010
weight: $weight
1111
---
1212

13-
An API object that represents a Redis Enterprise user.
14-
1513
| Name | Type/Value | Description |
1614
|------|------------|-------------|
1715
| uid | integer | User's unique ID |
1816
| account_id | integer | SM account ID |
1917
| action_uid | string | Action UID. If it exists, progress can be tracked by the `GET`&nbsp;`/actions/{uid}` API request (read-only) |
20-
| auth_method | **'regular'** | User's authentication method |
18+
| auth_method | **'regular'**<br />'certificate'<br />'entraid' | User's authentication method |
2119
| bdbs_email_alerts | complex object | UIDs of databases that user will receive alerts for |
2220
| cluster_email_alerts | boolean | Activate cluster email alerts for a user |
2321
| email | string | User's email (pattern matching only ASCII characters) |
@@ -26,6 +24,6 @@ An API object that represents a Redis Enterprise user.
2624
| password | string | User's password. If `password_hash_method` is set to `1`, the password should be hashed using SHA-256. The format before hashing is `username:clustername:password`. |
2725
| password_hash_method | '1' | Used when password is passed pre-hashed to specify the hashing method |
2826
| password_issue_date | string | The date in which the password was set (read-only) |
29-
| role | 'admin'<br />'cluster_member'<br />'cluster_viewer'<br />'db_member'<br /> **'db_viewer'** <br />'none' | User's [role]({{< relref "/operate/rs/references/rest-api/permissions#roles" >}}) |
27+
| role | 'admin'<br />'cluster_member'<br />'cluster_viewer'<br />'db_member'<br /> **'db_viewer'** <br />'user_manager'<br />'none' | User's [role]({{< relref "/operate/rs/references/rest-api/permissions#roles" >}}) |
3028
| role_uids | array of integers | UIDs of user's roles for role-based access control |
3129
| status | 'active'<br />'locked'<br />'password_expired' | User sign-in status (read-only)<br />**active**: able to sign in<br />**locked**: unable to sign in<br />**password_expired**: unable to sign in because the password expired |

‎content/operate/rs/references/rest-api/permissions.md‎

Lines changed: 63 additions & 60 deletions
Large diffs are not rendered by default.

‎content/operate/rs/references/rest-api/requests/bdbs/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Get all databases in the cluster.
3434

3535
| Permission name | Roles |
3636
|-----------------|---------|
37-
| [view_all_bdbs_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdbs_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
37+
| [view_all_bdbs_info]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdbs_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
3838

3939
### Request {#get-all-request}
4040

@@ -124,7 +124,7 @@ Get a single database.
124124

125125
| Permission name | Roles |
126126
|-----------------|-------|
127-
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
127+
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
128128

129129
### Request {#get-request}
130130

‎content/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Get optimized shards placement for the given database.
2828

2929
| Permission name | Roles |
3030
|-----------------|-------|
31-
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
31+
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
3232

3333
### Request {#get-request}
3434

‎content/operate/rs/references/rest-api/requests/bdbs/availability.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Verifies the local database endpoint is available. This request does not redirec
2828

2929
| Permission name | Roles |
3030
|-----------------|-------|
31-
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
31+
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
3232

3333
### Request {#get-endpoint-request}
3434

@@ -93,7 +93,7 @@ Gets the availability status of a database.
9393

9494
| Permission name | Roles |
9595
|-----------------|-------|
96-
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
96+
| [view_bdb_info]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_info" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
9797

9898
### Request {#get-db-request}
9999

‎content/operate/rs/references/rest-api/requests/bdbs/peer_stats.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Get statistics for all peer instances of a local CRDB instance.
2828

2929
| Permission name | Roles |
3030
|-----------------|-------|
31-
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
31+
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
3232

3333
### Request {#get-all-request}
3434

@@ -120,7 +120,7 @@ Get statistics for a specific CRDB peer instance.
120120

121121
| Permission name | Roles |
122122
|-----------------|-------|
123-
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
123+
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
124124

125125
### Request {#get-request}
126126

‎content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Get statistics for all databases.
2929

3030
| Permission name | Roles |
3131
|-----------------|-------|
32-
| [view_all_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
32+
| [view_all_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
3333

3434
### Request {#get-all-request}
3535

@@ -170,7 +170,7 @@ Get statistics for a specific database.
170170

171171
| Permission name | Roles |
172172
|-----------------|-------|
173-
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
173+
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
174174

175175
### Request {#get-request}
176176

‎content/operate/rs/references/rest-api/requests/bdbs/stats/last.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Get the most recent statistics for all databases.
2828

2929
| Permission name | Roles |
3030
|-----------------|-------|
31-
| [view_all_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
31+
| [view_all_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_all_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
3232

3333
### Request {#get-all-request}
3434

@@ -146,7 +146,7 @@ Get the most recent statistics for a specific database.
146146

147147
| Permission name | Roles |
148148
|-----------------|-------|
149-
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
149+
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
150150

151151
### Request {#get-request}
152152

‎content/operate/rs/references/rest-api/requests/bdbs/sync_source_stats.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Get stats for all syncer sources of a local database.
2828

2929
| Permission name | Roles |
3030
|-----------------|-------|
31-
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
31+
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
3232

3333
### Request {#get-all-request}
3434

@@ -111,7 +111,7 @@ Get stats for a specific syncer (Replica Of) instance.
111111

112112
| Permission name | Roles |
113113
|-----------------|-------|
114-
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer |
114+
| [view_bdb_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_bdb_stats" >}}) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |
115115

116116
### Request {#get-request}
117117

0 commit comments

Comments
 (0)