Team and accountSecurity
Two-factor and team security
Protect your account with an authenticator app and ten one-time recovery codes. Owners and admins can require two-factor for the whole team, limit how members sign in, sign them out after a set time and choose who can invite.
Two-factor for your account
Two-factor means a stolen password or sign-in link isn't enough: Orbits also asks for a code from an authenticator app on your phone when you sign in. It's set per person, on your account, and covers every team you're in.
Turn it on
- Go to Account and find the Two-factor card. It says Two-factor is off.
- Press Turn on two-factor.
- Scan the code with an authenticator app (1Password, Authy, Google Authenticator or any other that does time-based codes), or type the key shown under it.
- Enter the 6-digit code the app shows.
- Two-factor is on, and Orbits shows your recovery codes.
Starting again before you've entered a code just gives you a new key; nothing is on until the first code is accepted.
Signing in with two-factor
After the sign-in link, or GitHub, GitLab or Bitbucket, Orbits asks for a code:
- A code from the app is 6 digits and changes every 30 seconds. Each code works once.
- Or enter a recovery code. Case, spaces and the dash don't matter. A recovery code works once, ever.
- You have 10 minutes to enter it before you need to sign in again.
- After five wrong codes in a row, codes are refused for 15 minutes. The message says how long is left.
New recovery codes, and turning it off
The Two-factor card shows how many recovery codes you have left.
- Generate new recovery codes replaces them with ten new ones, shown once. Your old codes stop working. It asks for a current code from your app (or a recovery code).
- Turn off two-factor also asks for a current code or a recovery code, so someone who only has your session can't turn it off. Your recovery codes go with it.
If a team you're in requires two-factor, turning it off locks you out of that team until you turn it on again.
Team security rules
Owners and admins set these on Team › Settings › Security. They apply in this team only: a member who doesn't meet one is refused on this team, with a sentence saying why, while their other teams keep working.
Require two-factor for everyone
Turn on Require two-factor for everyone and every member must have two-factor on to use the team.
- You need two-factor on your own account first, so you can't lock yourself out.
- Members without it can still sign in, but this team's pages and its API answer with "This team requires two-factor authentication" until they turn it on. Members without it are asked to turn it on the next time they sign in. They can still leave the team.
- Their API tokens are refused too, since a token acts as the person who made it.
- The Security card lists the members who don't have it, and the Two-factor column on Team › Members shows everyone's status as of their last visit.
Sign-in methods
Choose how members may have signed in: Email link, GitHub, GitLab and Bitbucket. A member whose session started with a method you've switched off is refused on this team ("This team only allows signing in with GitHub…") until they sign out and in again with one that's allowed.
You must keep at least one method, and you can't switch off the one you signed in with yourself. Sessions started before Orbits recorded how people signed in count as an unknown method, so with a limit in place those members are asked to sign in again once.
These rules are for people signed in to the web app. API tokens aren't affected by them.
Sign members out after
1 day, 7 days or 30 days. A member whose session started longer ago than that is refused on this team ("…sign in again every 7 days…") until they sign in again. Every session ends after 30 days anyway. API tokens aren't affected.
Who can invite people
| Setting | Who can invite |
|---|---|
| Owners only | Owners and admins (the default) |
| Owners and members | Members too, as a member or viewer only |
Viewers never can, and only owners invite owners and admins. See inviting people.
API tokens can't change any of these rules.
Other protections
- Preview protection: password-protect a project's previews, or keep them to signed-in team members, from the project's settings. See previews.
- Sensitive environment variables are write-only: nobody can read them back. See environment variables.
- How Orbits keeps your data and code safe is on security and privacy.
From the API
| Call | |
|---|---|
GET /v1/me/two-factor | Whether it's on, since when, and recovery codes left |
POST /v1/me/two-factor, then POST /v1/me/two-factor/confirm with code | Turn it on. The confirm answer carries the recovery codes, once |
POST /v1/me/two-factor/recovery-codes with code | New recovery codes |
POST /v1/me/two-factor/disable with code | Turn it off |
PATCH /v1/teams/{team} | require_two_factor, sign_in_methods (email, github, gitlab, bitbucket), session_max_age_days, inviters (owners or members) |
See API › Authentication and API › Teams.