Sovrain
  1. Documentation
  2. Identity provider

Reference

Glossary

The terms used in the identity provider, with what each means in Sovrain.

Terms in alphabetical order. Labels from the screens are in bold.

Access token
A short-lived token an application receives at sign-in and sends to the userinfo endpoint. Valid 1 hour. See OpenID Connect.
ACS (assertion consumer service)
The address of a SAML application where Sovrain posts the sign-in response. Set under ACS URLs.
Active, next, retired key
The states of a signing key. The active key signs; a next key is published so applications can learn it before it signs; a retired key no longer signs.
Actor claim
The act claim (OpenID Connect) or actor attribute (SAML) that tells an application who signed in for the owner of a delegation. Off by default.
Admin API
The REST API for managing users, groups and applications, at https://acme.sovrain.net/api/v1. See Admin API.
Application
A service people sign in to through Sovrain, or receive accounts in through SCIM. Types: OpenID Connect (SSO), SAML 2.0 (SSO) and Standalone SCIM (provisioning only).
Attribute
A piece of information about a person, such as email or a custom department. Sent to applications as claims, SAML attributes or SCIM attributes.
Back-channel logout
A call from Sovrain’s server to an application’s server with a signed logout token when a Sovrain session ends, also after an admin action. Sovrain tries once, without retries. See OpenID Connect.
Claim
A named value in an OpenID Connect token, such as email or groups. See Claims and attributes.
Client ID, client secret
The identifier and the password of an OpenID Connect application. The secret is shown once.
Command-line access
The name of the built-in client cli on the approval page and on API access; the only client that can get an Admin API token.
Confidential client, public client
A confidential client keeps a client secret on a server. A public client (a single-page or mobile app) has no secret and must use PKCE.
A person’s permission for an application to read the scopes it asks for. Asked only when the application requires it.
Delegate
The person who signs in as someone else through a delegation.
Delegation
Permission for one person to sign in to chosen applications as another person, for a limited time. The admin pages say Delegations; the profile says Shared accounts. See About delegation.
Deprovisioning
Deactivating or deleting an account in an application over SCIM, when the person leaves the scope or is suspended or removed in Sovrain.
Device code
The code a command-line tool shows to get an Admin API token. An admin enters it at /device and approves.
Device flow
How a script gets an Admin API token: it shows a code, and an admin approves it in the browser at /device. See Get an Admin API token.
Discovery document
The JSON at /.well-known/openid-configuration that lists an organization’s OpenID Connect endpoints and features.
Drift
Accounts and groups in an application that Sovrain does not manage, found by reconciliation.
Entity ID
The name of a SAML party. The service provider’s entity ID is set per application; the IdP entity ID is https://acme.sovrain.net/saml/<slug>.
Grant (Admin API)
An admin’s approval for a tool to use the Admin API with chosen scopes. Lasts 30 days after its last refresh and at most 90 days.
Group access
The groups whose members may sign in to an application, each with an optional role.
ID token
The signed token that tells an OpenID Connect application who signed in. Valid 5 minutes.
IdP-initiated sign-in
A SAML sign-in that starts in Sovrain, from the application’s tile on the home page, rather than at the application.
Issuer
The address that identifies an organization as an OpenID Connect provider: https://acme.sovrain.net, or the primary custom domain.
JWKS
The organization’s public signing keys, at /oidc/jwks.json.
Launcher URL
The address the tile of an application on the home page opens.
Metadata
An XML document that describes a SAML party: its entity ID, endpoints and certificates.
NameID
The value that identifies the person in a SAML assertion. Taken from an attribute, email by default.
PKCE
A protection for the authorization code (code_challenge and code_verifier, method S256). Required by default.
Protected group
A group whose members can never have their account shared through delegation. Owners and Admins by default.
Provisioning
Creating and updating accounts in an application from Sovrain over SCIM. See SCIM.
Reconciliation
A comparison of an application’s accounts and groups with what Sovrain sent. Runs every 6 hours and never deletes.
Redirect URI
The address Sovrain sends a person back to after OpenID Connect sign-in. Must be registered exactly.
Refresh token
A token an application uses to get new tokens without the person. Works once, and lasts as long as the Sovrain session.
RelayState
A value a SAML application sends with a request and gets back unchanged with the response.
Role
Free text set on a group’s access to an application, sent to the application as role. Not a permission in Sovrain.
SAML
SAML 2.0, a sign-in protocol. Sovrain is the identity provider (IdP). See SAML.
SCIM
SCIM 2.0, a protocol for provisioning accounts. Sovrain is a SCIM client only.
SCIM server
The application’s side of SCIM, which receives accounts and groups from Sovrain. Sovrain is only the client. See Receive accounts from Sovrain over SCIM.
Scope (Admin API)
A permission of an Admin API token, such as users:read.
Scope (OpenID Connect)
A name an application asks for to receive a set of claims: openid, profile, email, groups.
Scope (SCIM)
Who is provisioned to an application: selected groups and users, or everyone.
Second step, second factor
What a person shows after the password: a code from an authenticator app, a security key, a passkey or a backup code.
Service provider (SP)
A SAML application.
Session
A signed-in browser. Lasts 60 days from sign-in.
Single Logout (SLO)
SAML sign-out that Sovrain sends, through the browser, to every application with Single Logout on where the person has a session. A sign-out started by one application does not reach the others, and admin actions do not trigger it.
Slug
The short name of an application in its URLs and in the API, such as portal.
SP-initiated sign-in
A SAML sign-in that starts at the application, which sends an authentication request to Sovrain.
Two-step sign-in
Signing in with a password and a second step. See Two-step methods.
Userinfo
The OpenID Connect endpoint that answers claims about the person for an access token.