diff --git a/changelog.mdx b/changelog.mdx index fcf9793925..d86e10bee8 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -578,7 +578,7 @@ noindex: true - **Result snippets:** Optionally show a one-line content preview beneath each search result, with matching terms highlighted. Enable **Result snippets** from your dashboard search settings; the setting is off by default. See [Result snippets](/optimize/search#result-snippets). - **Scoped `llms.txt` indexes:** Grouped `llms.txt` indexes are now served per URL segment at `/_llms/.md`, so agents can pull one section of your docs instead of the full index. - **Assistant widget analytics:** Analytics events now include the embedding page's current pathname by default and follow client-side navigation. Set `analytics.capturePathname` to `false` to opt out. See [assistant analytics config](/assistant/widget#assistantanalyticsconfig). - - **Bulk member invites:** Invite up to 250 teammates at once, then review the list and assign a role to each invitee before sending. Pro and Enterprise plans can upload a CSV of email addresses. See [Add members to your organization](/dashboard/roles#add-members-to-your-organization). + - **Bulk member invites:** Invite up to 250 teammates at once, then review the list and assign a role to each invitee before sending. Pro and Enterprise plans can upload a CSV of email addresses. See [Add members to your organization](/dashboard/members#add-members-to-your-organization). - **Universal Search API keys:** Universal Search API keys are out of early access. Any organization can now create and manage them from dashboard settings. - **Analytics in self-hosted deployments:** The dashboard analytics tab is now available on self-hosted deployments. diff --git a/dashboard/members.mdx b/dashboard/members.mdx new file mode 100644 index 0000000000..968ca22cd7 --- /dev/null +++ b/dashboard/members.mdx @@ -0,0 +1,63 @@ +--- +title: "Members" +description: "Invite members to your Mintlify organization, change their roles, remove them, and revoke their credentials from the Members page of your dashboard." +keywords: ["members", "invite", "bulk invite", "change role", "remove member", "revoke credentials", "session revocation", "offboarding"] +--- + +Manage who can access your organization's dashboard from the [Members](https://app.mintlify.com/settings/organization/members) page. Each member has a [role](/dashboard/roles) that controls what they can do. + +## Add members to your organization + +By default, the person who creates your Mintlify organization has admin access. Add additional members from the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard. + +Starter plans can have up to 5 members. Pro and Enterprise plans can invite any number of members. Editors and admins can invite editors and viewers. Only admins can invite other admins. + +1. Navigate to the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard. +2. In **New member**, enter email addresses, or paste a list separated by commas, semicolons, spaces, or new lines. You can invite up to 250 addresses at a time. +3. Choose a role. +4. Click **Invite**. + +If every address is new, the invites send right away. If any addresses are invalid, duplicates, or already members or invited, a review drawer opens. Remove rows or change roles, then click **Send invites**. + +On Pro and Enterprise plans, use **Bulk invite** to upload a CSV of emails. Choose a role, click **Invite**, and review the list before you send the invites. + +## Change a member's role + +Admins can change the role assigned to any member. See [Roles](/dashboard/roles) for what each role can do. + +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. + +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. + +## 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, open the actions menu and select **Remove member**. +3. Click **Remove** to confirm. + +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, open the actions menu and select **Revoke credentials**. +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. diff --git a/dashboard/roles.mdx b/dashboard/roles.mdx index 554541f8f8..9eb82c25ef 100644 --- a/dashboard/roles.mdx +++ b/dashboard/roles.mdx @@ -1,7 +1,7 @@ --- 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"] +description: "Compare the viewer, editor, and admin roles and the permissions each one grants in the Mintlify dashboard and editor." +keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "permissions"] boost: 3 --- @@ -11,6 +11,8 @@ boost: 3 Mintlify provides three dashboard access levels: viewer, editor, and admin. Without RBAC, every member has full access to your organization's dashboard, and new members join as editors. +To invite members, change their roles, or remove them, see [Members](/dashboard/members). + | | Viewer | Editor | Admin | | ------------------------------ | :----: | :----: | :---: | | View content in the editor | ✅ | ✅ | ✅ | @@ -52,59 +54,3 @@ Mintlify provides three dashboard access levels: viewer, editor, and admin. With ## 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. - -## Add members to your organization - -By default, the person who creates your Mintlify organization has admin access. Add additional members from the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard. - -Starter plans can have up to 5 members. Pro and Enterprise plans can invite any number of members. Editors and admins can invite editors and viewers. Only admins can invite other admins. - -1. Navigate to the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard. -2. In **New member**, enter email addresses, or paste a list separated by commas, semicolons, spaces, or new lines. You can invite up to 250 addresses at a time. -3. Choose a role. -4. Click **Invite**. - -If every address is new, the invites send right away. If any addresses are invalid, duplicates, or already members or invited, a review drawer opens. Remove rows or change roles, then click **Send invites**. - -On Pro and Enterprise plans, use **Bulk invite** to upload a CSV of emails. Choose a role, click **Invite**, and review the list before you send the invites. - -## 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. The change saves immediately. - -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. - -## 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, open the actions menu and select **Remove member**. -3. Click **Remove** to confirm. - -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, open the actions menu and select **Revoke credentials**. -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. diff --git a/docs.json b/docs.json index a545920426..62dfacaba6 100644 --- a/docs.json +++ b/docs.json @@ -270,6 +270,7 @@ "group": "Security", "pages": [ "dashboard/network-access", + "dashboard/members", "dashboard/roles", "dashboard/audit-logs", "dashboard/security-contact" diff --git a/migration-services/go-live-checklist.mdx b/migration-services/go-live-checklist.mdx index eb67ae7bbf..82a668281b 100644 --- a/migration-services/go-live-checklist.mdx +++ b/migration-services/go-live-checklist.mdx @@ -11,7 +11,7 @@ Use this checklist to set up configurations and validate settings before going l - **Add content to your repo.** If using Mintlify's [migration services](/migration-services/enterprise), extract the zip of migrated content that Mintlify delivers and add the files to your repository. - **Connect your docs repo to Mintlify.** Install the [GitHub App](/deploy/github), connect your [GitLab repository](/deploy/gitlab), or connect your [Bitbucket Cloud repository](/deploy/bitbucket). - If you store your documentation in more than one repository, configure a [multi-repository structure](/deploy/multi-repo) to build your site from multiple repos. If all of your content is in a single repository, skip this step. -- **Invite team members.** Invite anyone who needs access from the [Members](https://app.mintlify.com/settings/organization/members) page in your dashboard. See [Roles](/dashboard/roles) for more information. +- **Invite team members.** Invite anyone who needs access from the [Members](https://app.mintlify.com/settings/organization/members) page in your dashboard. See [Members](/dashboard/members) for more information. ## Security diff --git a/mint-instructions/access/team.mdx b/mint-instructions/access/team.mdx index e731ab5af0..b2dd6acf7a 100644 --- a/mint-instructions/access/team.mdx +++ b/mint-instructions/access/team.mdx @@ -58,6 +58,7 @@ Nothing in the repo changes, so `mint validate` proves nothing here. Ask the use ## More - `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 - https://www.mintlify.com/docs/dashboard/scim