Skip to content
Draft
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
2 changes: 2 additions & 0 deletions dashboard/members.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ 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. The change saves immediately.

If your organization can give members [roles on specific projects](/dashboard/roles#roles-on-specific-projects), you change roles from the member's actions menu instead. Select **Edit role** for the member whose role you want to adjust.

The new role takes effect the next time the member loads the dashboard. You can't change your own role. If a member's role comes from [SCIM directory sync](/dashboard/scim#roles-for-provisioned-members), their row shows **Managed by SSO**, and you change their role in your identity provider.

If your organization uses [expanded roles](/dashboard/roles#expanded-roles), the owner's role can only change if the owner transfers ownership to another member.
Expand Down
16 changes: 16 additions & 0 deletions dashboard/roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@
| Request a review | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |
| Approve review requests | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |
| Publish approved changes | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |
| Publish without review if review is required | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |

Check warning on line 87 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L87

In general, use active voice instead of passive voice ('is required').
| Merge branches from the editor without approval if review is required | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |

Check warning on line 88 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L88

In general, use active voice instead of passive voice ('is required').
| Manage site and workspace settings | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |
| Invite and remove members | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |
| Assign roles | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="x" color="#dc2626" /> No | <Icon icon="check" color="#16a34a" /> Yes | <Icon icon="check" color="#16a34a" /> Yes |
Expand Down Expand Up @@ -118,6 +118,22 @@

To change a custom role, open its actions menu in the **Custom roles** section and select **Manage role**.

## Roles on specific projects

If your organization has more than one project, you can give a member a role with more access on specific projects than their organization role. For example, a viewer in your organization can be an editor on one project. You can also block a member from a project with **No access**. A project role applies only to that project, not to your other projects.

1. Navigate to the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard.
2. In the member's row, open the actions menu and select **Edit role**. The **Edit access and permissions** drawer opens.
3. Under **Organization**, choose the member's organization role.
4. Each project's **Role** starts at the organization role. For each project you want to change, choose a higher role, or choose **No access** to block the member from that project. To remove a project role, choose the organization role again.
5. Click **Save**.

Roles that the organization role already includes are unavailable for a project. If you raise the organization role so it includes a project role, Mintlify removes that project role. Owners and admins already have full access to every project, so you can't set project roles for them or block them. You can only give project roles whose permissions you have. You can't change your own project roles.

**No access** hides the project from the member and blocks them from opening it in the dashboard or editor. If you promote a member to admin, Mintlify removes their **No access** assignments.

The **Role** column on the Members page shows each member's role on the project you have open, including **No access**.

## Repository contributors and deployments

Anyone with write access to your documentation repository can contribute by pushing changes. Pushes to your deploy branch deploy automatically, whatever the person's dashboard role. Dashboard roles only control what people can do in the Mintlify dashboard.
6 changes: 3 additions & 3 deletions mint-instructions/access/team.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@

If you meant who can read the published docs site (login, password, groups), run `mint instructions access` instead.

Use this to add teammates, set roles, SSO, SCIM, session or IP policies, audit logs, contacts, notifications, or the desktop app. All of it is configured in the dashboard (https://app.mintlify.com). You cannot set any of it from the repo, `docs.json`, or the `mint` CLI. Give the user exact steps and links.

Check warning on line 11 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L11

In general, use active voice instead of passive voice ('is configured').

## Workflow

1. Check the plan. Seat limits per plan: https://www.mintlify.com/pricing.md (do not quote seat counts from memory). Enterprise only: roles (RBAC), SSO, SCIM, session lifetimes, IP allowlist, audit logs, security contact. Audit log streaming: Enterprise add-on.
2. Add members: **Members** page (https://app.mintlify.com/settings/organization/members). In **New member**, enter emails (comma, semicolon, space or newline separated, up to 250 at once), choose a role (Enterprise defaults to Viewer), click **Invite**. Invalid or duplicate addresses open a review drawer: fix rows, **Send invites**. Pro and Enterprise: **Bulk invite** takes a CSV.
2. Add members: **Members** page (https://app.mintlify.com/settings/organization/members). In **New member**, enter emails (comma, semicolon, space or newline separated, up to 250), choose a role (Enterprise defaults to Viewer), click **Invite**. Invalid or duplicate addresses open a review drawer: fix rows, **Send invites**. Pro and Enterprise: **Bulk invite** takes a CSV.
3. Roles (Enterprise RBAC). Without RBAC every member has full dashboard access and new members join as editors. With RBAC:
- Standard roles: viewer (view, comment), editor (edit, publish, approve reviews, invite editors and viewers), admin (plus members, roles, billing, security, domain, Git source, deleting the project or org). Full table: https://www.mintlify.com/docs/dashboard/roles.
- Expanded roles: if the **Role** dropdown offers **Publisher**, roles are viewer, commenter (comments), editor (edits, requests review), publisher (publishes, approves), admin (publishes without review, manages members and billing), and one owner (can delete the project and org). Members assign roles up to their own. See https://www.mintlify.com/docs/dashboard/roles#expanded-roles.
- Custom roles (expanded roles only): **Members** page, **New custom role**. You can grant only permissions you have. See https://www.mintlify.com/docs/dashboard/roles#custom-roles.
- Review flow: with **Require review before publishing** on (Enterprise, GitHub only, admin-only setting), non-admins request review instead of publishing; editors or admins (publishers or admins with expanded roles) approve, then an admin or publisher publishes. Merging into the deploy branch from the editor or admin MCP: admins anytime, publishers once every change is approved; others use GitHub. See https://www.mintlify.com/docs/editor/review#require-review-before-publishing.

Check warning on line 21 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L21

In general, use active voice instead of passive voice ('is approved').
- Change a role: **Members** page, **Role** dropdown (saves immediately, applies on next dashboard load). You cannot change your own role. **Managed by SSO** rows change in the IdP. With expanded roles, the owner transfers ownership via an active, non-SSO member's **Role** dropdown (type `TRANSFER`) and becomes an admin.
4. Offboard: **Members** page, actions menu. **Remove member** deletes membership, access and their keys. **Revoke credentials** keeps membership and revokes any of: Sessions, CLI tokens, API keys, Discovery API keys, M2M clients, Connected apps. Not reversible; you cannot revoke your own. With expanded roles, you cannot remove the owner; transfer ownership first. **Managed by SSO** (SCIM) members: remove in the IdP.
- Change a role: **Members** page, **Role** dropdown (saves now, applies on reload). Not your own role. **Managed by SSO** rows change in the IdP. With expanded roles, the owner transfers ownership from an active, non-SSO member's **Role** dropdown (type `TRANSFER`), then is an admin. **Edit role**: higher role or **No access** per project (not admins, not yourself).
4. Offboard: **Members** page, actions menu. **Remove member** deletes membership, access and their keys. **Revoke credentials** keeps membership and revokes any of: Sessions, CLI tokens, API keys, Discovery API keys, M2M clients, Connected apps. Not reversible; not your own. With expanded roles, transfer ownership before removing the owner. **Managed by SSO** (SCIM) members: remove in the IdP.

Check warning on line 23 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L23

Did you really mean 'Offboard'?
5. SSO (Enterprise, admin): **Security** page (https://app.mintlify.com/settings/organization/access), **SSO** section. Each button opens the Admin Portal, which has the identity provider steps.
- First **Verify email domains**: add your team's email domain and its DNS record in the Admin Portal. **Set up SSO** stays disabled until a domain shows **Verified**.
- Then **Set up SSO** and follow the Admin Portal steps. When connected, the section shows **SAML SSO** with a **Connected** badge. **Manage SSO** reopens the portal.
- After you connect SSO, Mintlify sends anyone signing in with a verified-domain email to the IdP. Test sign-in from the login page and from the IdP in a private window.
- First SSO sign-in adds the user to the organization with the role the IdP assigns, or editor if none.
- Existing SSO or SCIM set up before the Admin Portal: reconnect by November 20, 2026 from the dashboard banner's **Set up now** (admins only). See https://www.mintlify.com/docs/help-center/reconnect-existing-sso-and-scim.

Check warning on line 29 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L29

Use 'SSO' instead of 'sso'.

Check warning on line 29 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L29

Use 'SCIM' instead of 'scim'.
6. SCIM (Enterprise, admin): **Security** page, **SCIM** section, **Set up directory sync**, follow the Admin Portal steps. **Manage directory** reopens the portal. Roles follow the IdP's role assignments; provisioned members show **Managed by SSO** on **Members**, so change their roles in the IdP.
7. Session and network policies (Enterprise, admin): **Security** page, **Policies** section.
- **Idle session timeout** and **Maximum session lifetime**: each 5 minutes to 14 days, own toggle, click **Save**. Session ends at whichever limit hits first. Off: idle timeout falls back to 14 days, max lifetime has no limit. Lowering max lifetime ends older sessions on their next request.
Expand All @@ -42,7 +42,7 @@

- Never claim you configured members, roles, SSO, SCIM or policies. Hand the user the steps; an admin must do the admin-only ones.
- Dashboard roles do not gate Git. Anyone with write access to the repo can push, and pushes to the deploy branch deploy regardless of role. Lock down the repo separately.
- Before an IP allowlist, confirm the admin's current IP (shown in **Policies**) is on it, or they lock themselves out.

Check warning on line 45 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L45

Did you really mean 'admin's'?

## Examples

Expand All @@ -61,6 +61,6 @@
- `mint instructions access` (docs-site reader access)
- https://www.mintlify.com/docs/dashboard/members
- https://www.mintlify.com/docs/dashboard/roles
- https://www.mintlify.com/docs/dashboard/sso

Check warning on line 64 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L64

Use 'SSO' instead of 'sso'.
- https://www.mintlify.com/docs/dashboard/scim

Check warning on line 65 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L65

Use 'SCIM' instead of 'scim'.
- https://www.mintlify.com/docs/dashboard/network-access
Loading