Sovrain
  1. Documentation
  2. Get started

Explanation

How Sovrain fits together

The few ideas behind Sovrain: an organization, its people and groups, the apps they sign in to, and the parts of the product.

The video plays in the corner.

Sovrain gives a company one place where its people have their accounts, and lets every application the company uses rely on that place to know who someone is. A handful of ideas explain almost everything else in this documentation.

An organization is your company’s own Sovrain

When a company starts with Sovrain, it creates an organization. The organization has its own address, such as https://acme.sovrain.net or a domain of the company’s own, its own people, its own settings and its own data, kept apart from every other organization. Accounts belong to one organization: someone who works for two companies has two accounts. Organizations and their addresses goes deeper.

People have accounts; admins look after them

Everyone in the organization has an account: a login name or email address, a password and, ideally, a second step after the password, such as an authenticator app or a passkey (About two-step sign-in). Admins are the people in the organization’s Admins or Owners groups. They invite people, set the sign-in rules and connect applications. Owners can also do the few things that reach past one person: import a backup and reset the password or second step of another admin.

Groups decide who uses what

Every person is in the group All, and admins create more groups for teams, such as Engineering. Groups are how Sovrain decides access: an application lets in exactly the people in the groups that were given access to it, and a group can carry a role that tells the application what the person may do there. Access, groups and roles explains why access works only through groups.

Applications trust Sovrain to tell them who someone is

An application, such as a wiki or a monitoring tool, is connected to the organization once, by an admin. From then on, when someone opens it, the application sends them to Sovrain; Sovrain checks their password and second step, and sends them back with a signed statement of who they are. That is single sign-on, and Sovrain speaks the two common languages for it, OpenID Connect and SAML. Sovrain can also create and update the person’s account inside an application ahead of time, over SCIM, so it is ready when they first arrive.

The parts of Sovrain

The documentation follows the parts of the product:

  • Your account is what every person does: sign in, add a second step, manage sessions and their profile.
  • Your organization is what admins manage for the whole company: people, groups, sign-in rules such as required two-step sign-in and account recovery, the address, branding and backups.
  • Identity provider is signing in to applications: connecting them, what they receive about a person, provisioning, and what developers build against.
  • Password manager keeps passwords, files and one-time codes encrypted in the browser and shares them inside the company.
  • Self-hosting is for operators who run Sovrain on their own servers instead of using sovrain.net.

Each part uses the same people and groups, so a group created once gives access to applications and to shared passwords alike.