mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
e08cd283a9
* docs: address reader-question gaps on recently updated pages * docs: mirror gap-filling edits to es, fr, zh translations * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
91 lines
4.6 KiB
Plaintext
91 lines
4.6 KiB
Plaintext
---
|
|
title: "Roles"
|
|
description: "Assign admin, editor, or viewer roles to team members to control access levels, editing permissions, and deployment capabilities in Mintlify."
|
|
keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "permissions", "revoke credentials", "session revocation"]
|
|
boost: 3
|
|
---
|
|
|
|
<Info>
|
|
Role-based access control (RBAC) is available on [Enterprise plans](https://mintlify.com/pricing?ref=rbac).
|
|
</Info>
|
|
|
|
Mintlify provides three dashboard access levels: viewer, editor, and admin.
|
|
|
|
| | Viewer | Editor | Admin |
|
|
| ------------------------------ | :----: | :----: | :---: |
|
|
| View content in the editor | ✅ | ✅ | ✅ |
|
|
| View dashboard and analytics | ✅ | ✅ | ✅ |
|
|
| Ask the [Slack agent](/agent/slack) questions | ✅ | ✅ | ✅ |
|
|
| Make changes with the Slack agent | ❌ | ✅ | ✅ |
|
|
| Edit content in the web editor | ❌ | ✅ | ✅ |
|
|
| Publish changes | ❌ | ✅ | ✅ |
|
|
| Create, rename, and delete pages | ❌ | ✅ | ✅ |
|
|
| Reorder navigation | ❌ | ✅ | ✅ |
|
|
| Upload media | ❌ | ✅ | ✅ |
|
|
| Trigger deployments | ❌ | ✅ | ✅ |
|
|
| Create and delete API keys | ❌ | ✅ | ✅ |
|
|
| Configure integrations | ❌ | ✅ | ✅ |
|
|
| Configure assistant | ❌ | ✅ | ✅ |
|
|
| Configure add-ons | ❌ | ✅ | ✅ |
|
|
| Invite editors and viewers | ❌ | ✅ | ✅ |
|
|
| Update user roles | ❌ | ❌ | ✅ |
|
|
| Invite admins | ❌ | ❌ | ✅ |
|
|
| Delete users | ❌ | ❌ | ✅ |
|
|
| Manage billing | ❌ | ❌ | ✅ |
|
|
| Manage SSO | ❌ | ❌ | ✅ |
|
|
| Update custom domain | ❌ | ❌ | ✅ |
|
|
| Update Git source | ❌ | ❌ | ✅ |
|
|
| Delete organization | ❌ | ❌ | ✅ |
|
|
|
|
<Tip>
|
|
Limit admin access to only the people who need to perform admin tasks.
|
|
</Tip>
|
|
|
|
## Add members to your organization
|
|
|
|
By default, the person who creates your Mintlify organization has admin access. Add additional members in the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard.
|
|
|
|
You can invite any number of members to your organization.
|
|
|
|
## Change a member's role
|
|
|
|
Admins can change the role assigned to any member.
|
|
|
|
1. Navigate to the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard.
|
|
2. In the member's row, select a new role from the role dropdown.
|
|
3. Confirm the change.
|
|
|
|
The new role takes effect the next time the member loads the dashboard.
|
|
|
|
## Remove a member
|
|
|
|
Admins can remove a member from the organization entirely, which deletes their access and any keys they created.
|
|
|
|
1. Navigate to the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard.
|
|
2. In the member's row, click the <Icon icon="trash" /> **Remove** button.
|
|
3. Confirm the removal.
|
|
|
|
Removing a member deletes the member from your organization. Revoking a member's credentials signs them out and clears their keys, but keeps their membership.
|
|
|
|
## Revoke a member's credentials
|
|
|
|
Admins can sign a member out of the dashboard and revoke their keys and tokens without removing them from the organization. Use credential revocation when offboarding someone or responding to a compromised account.
|
|
|
|
1. Navigate to the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard.
|
|
2. In the member's row, click the <Icon icon="shield-off" /> **Revoke credentials** button.
|
|
3. Select which credentials to revoke.
|
|
4. Click **Revoke**.
|
|
|
|
You can revoke any combination of the following credentials:
|
|
|
|
| Credential | What revoking it does |
|
|
| ---------- | --------------------- |
|
|
| Sessions | Signs the member out of the dashboard. |
|
|
| CLI tokens | Signs the member out of the [CLI](/cli/install). |
|
|
| API keys | Deletes the API keys that the member created. |
|
|
| Discovery API keys | Deletes the discovery API keys that the member created. |
|
|
| M2M clients | Revokes the member's machine-to-machine client credentials. |
|
|
| Connected apps | Disconnects the apps the member authorized through OAuth. |
|
|
|
|
Revoking credentials cannot be undone. The member can sign in again and create new keys and tokens unless you also remove them from the organization or block their sign-in method. You cannot revoke your own credentials.
|