Coverage

What is coverage?

Coverage is the set of unique identifiers attached to a user entity. Every user has a uuid as the primary key; some also carry an oid (ObjectId) — the identifier format commonly used in MongoDB-based systems.

Which identifiers a user ends up with is decided at registration time, by the client that initiated the registration.

How to register a user with additional coverage

When a client redirects to the Vault OAuth gateway, the user can in turn navigate to the register form. Vault preserves all query parameters from the client’s original redirect throughout the login/register session, so the coverage the client requested travels with the user to the register form.

When the user completes registration, the coverage carried over from the client is submitted along with the registration — and the additional unique identifier is attached to the resulting user entity.

Each client with a redirect to Vault is therefore responsible for including the coverage it requires for its use case. A client that needs its users to have an oid must request it at registration — coverage can be added to an existing user after the fact by the account holder.

Available coverage

To date, Vault has 2 coverage values:

You can see a redirect URL example in Auth flow