Skip to content

Commit

Permalink
docs: update sign-in-restriction
Browse files Browse the repository at this point in the history
  • Loading branch information
tianzhou committed Jan 17, 2025
1 parent 2ea1a4f commit 31a372e
Showing 1 changed file with 14 additions and 22 deletions.
36 changes: 14 additions & 22 deletions content/docs/administration/sign-in-restriction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,40 @@
title: Sign-in Restriction
---

This document explains some sign-in restrictions.
<HintBlock type="info">

Only **Workspace Admin** can update the settings.

</HintBlock>

## Sign-in Frequency

<PricingPlanBlock feature_name='SIGNIN_FREQUENCY' />

**Sign-in Frequency** specifies the period that users are required to sign in again.

Only **Workspace Admin** can update the **Sign-in Frequency** settings.

In Bytebase Workspace, Go to **Settings** -> **General** and scroll down to **Account** section, where you can

- Choose between `Hour(s)` and `Day(s)`.
- Click `+`,`-` or input a number to set the **Sign-in Frequency**.
In Bytebase Workspace, Go to **Settings** -> **General** and scroll down to **Account** section.

![sign-in-frequency](/content/docs/administration/sign-in-restriction/sign-in-frequency.webp)

<HintBlock type="info">

You need to restart Bytebase and re-login to make the change take effect.

</HintBlock>
You need to restart Bytebase to make the change take effect.

## Disallow Sign-in with Email & Password

<PricingPlanBlock feature_name='SSO' />

As `Workspace Admin`, having had [SSO](https://www.bytebase.com/docs/administration/sso/overview) (for example [OAuth 2.0 in GitHub](https://www.bytebase.com/docs/administration/sso/oauth2/#github)) configured, you can [enforce SSO sign-in](https://www.bytebase.com/docs/administration/sso/overview/#enforce-sso-sign-in) for all users in Workspace.
Once [SSO](/docs/administration/sso/overview) is configured, you can [enforce SSO sign-in](/docs/administration/sso/overview/#enforce-sso-sign-in) for all users.

## Sign-in from Email Domains

Go to **Settings** -> **General**, scroll down to **Security** section. Fill in `Workspace Domain` tab with the email domain for your Workspace members. Click **Update** to save changes.
Go to **Settings** -> **General**, scroll down to **Security** section. Fill in `Workspace Domain` tab with the email domain for your Workspace members. Then tick the `Members restriction` box.

![set-domain](/content/docs/administration/sign-in-restriction/set-domain.webp)

You can restrict members' email addresses by ticking the `Members restriction` box. Afterwards, when you
- Sign in (Note that the new restriction only works for the accounts registered after the `Workspace Domain` was updated)
![sign-in-domain-restriction](/content/docs/administration/sign-in-restriction/sign-in-domain-restriction.webp)

or
Domain restriction applies to:

- **Add User** in **IAM & Admin** -> **Users & Groups**
![add-user-domain-restriction](/content/docs/administration/sign-in-restriction/add-user-domain-restriction.webp)
- Sign-in page. (Note that the new restriction only applies to the accounts registered after the `Workspace Domain` was updated)
![sign-in-domain-restriction](/content/docs/administration/sign-in-restriction/sign-in-domain-restriction.webp)

Users' email must be of the domain you set in both scenarios.
- **Add User** in **IAM & Admin** -> **Users & Groups**. Users' email must be of the domain you set in both scenarios.
![add-user-domain-restriction](/content/docs/administration/sign-in-restriction/add-user-domain-restriction.webp)

0 comments on commit 31a372e

Please sign in to comment.