mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
e3d9a5ade2
* docs: address reader-question gaps flagged by quality check * docs: mirror English gap fixes 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>
58 lines
3.6 KiB
Plaintext
58 lines
3.6 KiB
Plaintext
---
|
|
title: "Dashboard access policies"
|
|
sidebarTitle: "Access policies"
|
|
description: "Restrict Mintlify dashboard access to trusted IP addresses and control how long dashboard sessions stay valid with idle timeouts and maximum session lifetimes."
|
|
keywords: ["IP allowlist", "network access", "CIDR", "IP restrictions", "security", "dashboard access", "trusted IPs", "session lifetime", "idle timeout", "session duration"]
|
|
---
|
|
|
|
<Info>
|
|
Dashboard access policies require an [Enterprise plan](https://mintlify.com/pricing?ref=network-access).
|
|
</Info>
|
|
|
|
Control how organization members access the Mintlify dashboard. You can restrict access to trusted IP addresses and set how long dashboard sessions stay valid. Manage both policies on the **Policies** tab of the [Identity & access](https://app.mintlify.com/settings/organization/access) page in your dashboard.
|
|
|
|
## IP allowlist
|
|
|
|
Use an IP allowlist to restrict dashboard and editor access to trusted IP addresses and Classless Inter-Domain Routing (CIDR) ranges. When you enable the allowlist, organization members can only sign in and use the dashboard and web editor from an allowed IP address.
|
|
|
|
The IP allowlist applies to your Mintlify dashboard and editor, including SSO and break-glass sign-ins. It does not affect your published documentation site. API requests use separate IP controls.
|
|
|
|
If a member tries to sign in or use the dashboard from a blocked IP address, Mintlify rejects the request. It shows a message explaining that the address is not on the allowlist. Members can contact an admin to have their address added.
|
|
|
|
You can allow access two ways:
|
|
|
|
- **Individual IP address**: Allow a single address, such as `203.0.113.7` or `2001:db8::1`.
|
|
- **CIDR range**: Allow a block of addresses, such as `10.0.0.0/8` or `2001:db8::/48`. Use CIDR notation to grant access to an entire office or VPN network without listing each address individually.
|
|
|
|
Both IPv4 and IPv6 addresses are supported.
|
|
|
|
### Configure the IP allowlist
|
|
|
|
<Warning>
|
|
Add your current IP address to the allowlist before enabling it. If your address is not on the list, you can lock yourself out of the dashboard. The **Policies** tab displays your current IP address to help you avoid this.
|
|
</Warning>
|
|
|
|
1. In your Mintlify dashboard, navigate to the [Identity & access](https://app.mintlify.com/settings/organization/access) page.
|
|
2. On the **Policies** tab, under **Allowed IP addresses**, enter an individual IP address (for example, `203.0.113.7`) or a CIDR range (for example, `10.0.0.0/8`).
|
|
3. Click **Add**.
|
|
4. Repeat for each address or range you want to allow.
|
|
5. Enable the allowlist to begin enforcing it.
|
|
|
|
## Session lifetimes
|
|
|
|
Control how long dashboard sessions stay valid before members must sign in again. You can set two independent limits:
|
|
|
|
- **Maximum session lifetime**: Members must sign in again once a session reaches this age, regardless of activity. When off, sessions have no maximum age.
|
|
- **Idle session timeout**: Members are signed out after this period of inactivity. When off, sessions time out after 14 days of inactivity.
|
|
|
|
Both limits accept values from 5 minutes to 14 days.
|
|
|
|
### Configure session lifetimes
|
|
|
|
1. In your Mintlify dashboard, navigate to the [Identity & access](https://app.mintlify.com/settings/organization/access) page.
|
|
2. On the **Policies** tab, under **Session lifetimes**, toggle on **Maximum session lifetime** or **Idle session timeout**.
|
|
3. Set a duration for each limit that you enable.
|
|
4. Click **Save**.
|
|
|
|
Lowering the maximum session lifetime applies to active sessions immediately. Any session older than the new limit ends the next time it makes a request. Changes to the idle session timeout take effect as active sessions refresh.
|