Skip to content

Commit 9480661

Browse files
authored
chore: add console roles and permissions (#2438)
1 parent c642938 commit 9480661

File tree

3 files changed

+120
-1
lines changed

3 files changed

+120
-1
lines changed
Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
id: roles-and-permissions
3+
title: Roles and permissions in the Ory Console
4+
sidebar_label: Roles and permissions
5+
---
6+
7+
The Ory Console uses role-based access control enforced through Ory Keto. Roles are assigned at two levels: workspace and project.
8+
9+
## Workspace roles
10+
11+
A workspace has two roles: Owner and Developer.
12+
13+
### Owner
14+
15+
The Owner role has full administrative control over the workspace.
16+
17+
- View and edit workspace metadata
18+
- Upgrade the workspace plan
19+
- View and manage billing
20+
- View and manage members
21+
- Create and delete workspace API keys
22+
- Create projects and view the projects list
23+
24+
### Developer
25+
26+
The Developer role provides day-to-day access without administrative capabilities.
27+
28+
- View workspace metadata
29+
- Create projects and view the projects list
30+
- View members
31+
- View workspace API keys
32+
33+
Developers cannot:
34+
35+
- Edit workspace metadata
36+
- Manage billing
37+
- Manage workspace members
38+
- Create or delete workspace API keys
39+
40+
### Workspace permission matrix
41+
42+
| Permission | Developer | Owner |
43+
| -------------------------------- | --------- | ----- |
44+
| View workspace metadata | Yes | Yes |
45+
| Edit workspace metadata | No | Yes |
46+
| Upgrade workspace plan | No | Yes |
47+
| View billing | No | Yes |
48+
| Manage billing | No | Yes |
49+
| View members | Yes | Yes |
50+
| Manage members | No | Yes |
51+
| View workspace API keys | Yes | Yes |
52+
| Create/delete workspace API keys | No | Yes |
53+
| Create projects | Yes | Yes |
54+
| View projects list | Yes | Yes |
55+
56+
## Project roles
57+
58+
A project has two roles: Owner and Developer.
59+
60+
### Owner
61+
62+
The Owner role has full control over the project, including destructive and administrative actions. Owners inherit all Developer
63+
permissions.
64+
65+
In addition to Developer permissions, Owners can:
66+
67+
- Delete the project
68+
- Move the project between workspaces
69+
- Upgrade the project plan
70+
- Add and remove collaborators
71+
- Modify project workspace settings
72+
73+
### Developer
74+
75+
The Developer role provides full access to project configuration and all Ory services.
76+
77+
- Read and write project configuration
78+
- View collaborators
79+
- Manage project API keys
80+
- Manage custom domains (CNAMEs)
81+
- Manage event streams
82+
- Full access to Ory Identities (read/write identities, credentials, sessions, and messages)
83+
- Full access to Ory Permissions (read/write relationships, read permissions)
84+
- Full access to Ory OAuth2 (read/write clients)
85+
86+
Developers cannot:
87+
88+
- Delete or move the project
89+
- Add or remove collaborators
90+
- Modify project workspace settings
91+
92+
### Project permission matrix
93+
94+
| Permission | Owner | Developer |
95+
| --------------------------------- | ----- | --------- |
96+
| Read project configuration | Yes | Yes |
97+
| Write project configuration | Yes | Yes |
98+
| View collaborators | Yes | Yes |
99+
| Add/remove collaborators | Yes | No |
100+
| Manage project API keys | Yes | Yes |
101+
| Manage custom domains (CNAMEs) | Yes | Yes |
102+
| Manage event streams | Yes | Yes |
103+
| Ory Identities (full read/write) | Yes | Yes |
104+
| Ory Permissions (full read/write) | Yes | Yes |
105+
| Ory OAuth2 (full read/write) | Yes | Yes |
106+
| Delete project | Yes | No |
107+
| Move project | Yes | No |
108+
| Upgrade project plan | Yes | No |
109+
| Modify workspace settings | Yes | No |
110+
111+
## Managing roles
112+
113+
To change a member's role, a workspace Owner can go to <ConsoleLink route="workspace.settings.members" />.
114+
115+
![Workspace members](./_static/workspace-settings-members-page.png)
116+
117+
For more information on workspaces and member management, see [Workspaces & Environments](../guides/workspaces.mdx).

docs/guides/workspaces.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ The Workspace Members page provides a comprehensive view of your team and access
4343
:::note
4444

4545
The screenshot shows that all members are listed as "Owners". In practice, you may have different roles such as Owner or
46-
Developer.
46+
Developer. For a full breakdown of what each role can do, see
47+
[Roles and permissions in the Ory Console](../console/roles-and-permissions.mdx).
4748

4849
:::
4950

src/sidebar.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@ const operations: SidebarItemsConfig = [
288288
collapsible: false,
289289
items: [
290290
"guides/workspaces",
291+
"console/roles-and-permissions",
291292
"guides/custom-domains",
292293
"console/usage-billing",
293294
"guides/manage-project-via-api",

0 commit comments

Comments
 (0)