Skip to content

Commit 648bd4c

Browse files
committed
add rbac and fixes
1 parent 28a96f2 commit 648bd4c

File tree

3 files changed

+51
-10
lines changed

3 files changed

+51
-10
lines changed

docs/mint.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@
8080
"platform/overview",
8181
"platform/apps/apps",
8282
"platform/apps/environment",
83-
"platform/apps/languages",
8483
"platform/integrations/integrations",
8584
"platform/integrations/integration-rule",
8685
"platform/events/events",

docs/platform/account/roles

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: "Role-based Access Control"
3+
---
4+
5+
Role based access control is available for all Raven customers. If you want to control user roles of the users at app-level, you need to upgrade to Raven’s Enterprise plan.
6+
7+
In our RBAC model, we provide a set of user roles that controls their
8+
9+
1. Account permissions
10+
2. App permissions
11+
12+
## User Roles (Account)
13+
14+
An account role allows permissions for actions at Account level like invite members, edit account details, billing etc. An account has 2 roles :
15+
16+
1. **Owner** - This role allows users to have complete control over the account and app permissions.
17+
2. **Member** - This role allows only read permissions for actions at Account level. A member can be an admin/ editor/ viewer for multiple apps (discussed below)
18+
19+
## User Roles (App)
20+
21+
An app Role allows permissions for actions at App level like viewing/editing logs, metrics, event, providers and inviting members to that app.
22+
23+
1. **Admin** - A user with Admin permissions in an app has complete control over the app and also can invite new members to that app.
24+
2. **Editor** - A user with Editor permissions in an app can edit events/ providers in an app but cannot invite members to that app.
25+
3. **Viewer** - A user with Viewer permissions has access to only view data on that app.
26+
27+
## App Privacy Access
28+
29+
An App can have public or private access. This helps you to control who can access the apps.
30+
31+
1. **Public**: This allows all the members of that account to access this app.
32+
2. **Private**: This allows only members invited to that app to access the app.
33+
34+
Private App is only present in Raven’s enterprise plan. With this feature, admins can add only relevant users in an app. For example - this allows account administrators to create multiple apps for each company’s department and allow only members of that dept to access the app.
35+
36+
**Permissions Matrix**
37+
38+
| Account level Role | App Level Role | Invite new members to account | Invite new members to app | Can edit App Invitations and App Members | Can edit Account Invitations and Account Members |
39+
| --- | --- | --- | --- | --- | --- |
40+
| Owner | Admin | ✅ | ✅ | ✅ | ✅ |
41+
| Member | Admin | ❌ | ✅ | ✅ | ❌ |
42+
| Member | Editor | ❌ | ❌ | ❌ | ❌ |
43+
| Member | Viewer | ❌ | ❌ | ❌ | ❌ |
44+
45+
| | Public Apps | Private Apps |
46+
| --- | --- | --- |
47+
| Enterprise | ✅ | ✅ |
48+
| Startup | ✅ | ❌ |

docs/platform/apps/environment.mdx

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,18 @@
11
---
22
title: "Environment"
3-
description: "Environment helps you signify the type of App. There are three App environments"
43
---
54

6-
1. **Development**:
5+
1. **Test**:
76

87
A working environment to play around with the platform.
98

10-
2. **Staging**:
11-
12-
Used for testing to test changes before releasing them to Production. Similar
13-
to the staging environment that you would have in your backend.
14-
15-
3. **Production**:
9+
2. **Production**:
1610

1711
This is the live production environment and should be treated carefully since
1812
it could affect your users.
1913

2014
<Info>
21-
Currently, Environments are only for your understanding and to add a semantic
15+
Currently, environments are only for your understanding and to add a semantic
2216
meaning to Apps. We do intend to add Environment based API rate-limiting later
2317
on.
2418
</Info>

0 commit comments

Comments
 (0)