Skip to content

Commit

Permalink
Merge pull request #1374 from appwrite/add-roles-docs
Browse files Browse the repository at this point in the history
chore: add docs for roles
  • Loading branch information
TorstenDittmann authored Sep 25, 2024
2 parents 5a643fc + 4b92673 commit f4888e6
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/routes/docs/advanced/platform/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
{
label: 'Shortcuts',
href: '/docs/advanced/platform/shortcuts'
},
{
label: 'Roles',
href: '/docs/advanced/platform/roles'
}
]
},
Expand Down
29 changes: 29 additions & 0 deletions src/routes/docs/advanced/platform/roles/+page.markdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: article
title: Roles
description: Learn how to setup role-based access controls in the Appwrite Console
---

The Appwrite Console supports granular permissions to improve team collaboration and security. Each member of your Console team can be assigned a specific role that grants them access to certain areas of your organization's projects. Below is a breakdown of the new roles available, detailing their permissions and intended use cases.

{% info title="Note" %}
This page covers organization member roles for the Appwrite Console. Visit the Auth [roles documentation](https://appwrite.io/docs/products/auth/teams#permissions) if you want to learn more about roles for the [Teams service](https://appwrite.io/docs/references/cloud/client-web/teams).
{% /info %}

## Owner {% #owner %}
The highest level of access, the Owner role has full control over all aspects of the Console, including team management, billing, and all development resources. Only owners can create new projects.

## Developer {% #developer %}
Developers have access to all resources and scopes available to the Owner, with the exception of team management and billing writes. This role is ideal for team members focusing solely on development tasks.

## Editor {% #editor %}
Editors can modify most resources but do not have write permissions for critical backend elements like collections, buckets, topics, and others. This role is intended for users who need to modify content or make changes but should not alter key infrastructure elements. This is great if you need to give access for updating your documents, creating messages, or uploading files.

## Analyst {% #analyst %}
Analysts are limited to read-only access across all resources. This role is suitable for team members who need to view data, analytics, or reports but do not require editing permissions.

## Billing {% #billing %}
Billing users are restricted to billing-related actions, with access to `billing.read` and `billing.write` scopes only. They can view and manage billing details but cannot interact with other parts of the system.

## Custom roles {% #custom-roles %}
Custom roles will soon be available on the Appwrite Console. Custom roles will be a Scale and Enterprise plans feature.

0 comments on commit f4888e6

Please sign in to comment.