Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions docs/console/roles-and-permissions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
id: roles-and-permissions
title: Roles and permissions in the Ory Console
sidebar_label: Roles and permissions
---

The Ory Console uses role-based access control enforced through Ory Keto. Roles are assigned at two levels: workspace and project.

## Workspace roles

A workspace has two roles: Owner and Developer.

### Owner

The Owner role has full administrative control over the workspace.

- View and edit workspace metadata
- Upgrade the workspace plan
- View and manage billing
- View and manage members
- Create and delete workspace API keys
- Create projects and view the projects list

### Developer

The Developer role provides day-to-day access without administrative capabilities.

- View workspace metadata
- Create projects and view the projects list
- View members
- View workspace API keys

Developers cannot:

- Edit workspace metadata
- Manage billing
- Manage workspace members
- Create or delete workspace API keys

### Workspace permission matrix

| Permission | Developer | Owner |
| -------------------------------- | --------- | ----- |
| View workspace metadata | Yes | Yes |
| Edit workspace metadata | No | Yes |
| Upgrade workspace plan | No | Yes |
| View billing | No | Yes |
| Manage billing | No | Yes |
| View members | Yes | Yes |
| Manage members | No | Yes |
| View workspace API keys | Yes | Yes |
| Create/delete workspace API keys | No | Yes |
| Create projects | Yes | Yes |
| View projects list | Yes | Yes |

## Project roles

A project has two roles: Owner and Developer.

### Owner

The Owner role has full control over the project, including destructive and administrative actions. Owners inherit all Developer
permissions.

In addition to Developer permissions, Owners can:

- Delete the project
- Move the project between workspaces
- Upgrade the project plan
- Add and remove collaborators
- Modify project workspace settings

### Developer

The Developer role provides full access to project configuration and all Ory services.

- Read and write project configuration
- View collaborators
- Manage project API keys
- Manage custom domains (CNAMEs)
- Manage event streams
- Full access to Ory Identities (read/write identities, credentials, sessions, and messages)
- Full access to Ory Permissions (read/write relationships, read permissions)
- Full access to Ory OAuth2 (read/write clients)

Developers cannot:

- Delete or move the project
- Add or remove collaborators
- Modify project workspace settings

### Project permission matrix

| Permission | Owner | Developer |
| --------------------------------- | ----- | --------- |
| Read project configuration | Yes | Yes |
| Write project configuration | Yes | Yes |
| View collaborators | Yes | Yes |
| Add/remove collaborators | Yes | No |
| Manage project API keys | Yes | Yes |
| Manage custom domains (CNAMEs) | Yes | Yes |
| Manage event streams | Yes | Yes |
| Ory Identities (full read/write) | Yes | Yes |
| Ory Permissions (full read/write) | Yes | Yes |
| Ory OAuth2 (full read/write) | Yes | Yes |
| Delete project | Yes | No |
| Move project | Yes | No |
| Upgrade project plan | Yes | No |
| Modify workspace settings | Yes | No |

## Managing roles

To change a member's role, a workspace Owner can go to <ConsoleLink route="workspace.settings.members" />.

![Workspace members](./_static/workspace-settings-members-page.png)

For more information on workspaces and member management, see [Workspaces & Environments](../guides/workspaces.mdx).
3 changes: 2 additions & 1 deletion docs/guides/workspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ The Workspace Members page provides a comprehensive view of your team and access
:::note

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

:::

Expand Down
1 change: 1 addition & 0 deletions src/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ const operations: SidebarItemsConfig = [
collapsible: false,
items: [
"guides/workspaces",
"console/roles-and-permissions",
"guides/custom-domains",
"console/usage-billing",
"guides/manage-project-via-api",
Expand Down
Loading