Skip to content

The end-user portal

Besides the Provision Portal you work in, Oclavex ships a separate end-user portal for your customers’ users: a small self-service app where a person signs in, activates a license and sees what’s assigned to them. It’s served under your tenant at /userportal and is available on plans with the End-user portal feature — see Oclavex Plans.

Page What it does
Activate Redeem an activation code. On success the user sees the license description and its included features.
My Licenses The entitlements assigned to the signed-in user — description, products, license key, subscription status and expiry. Opening one shows the plan it’s on, live metered usage against its quotas, prepaid credit balances, fixed limits and capability grants — and a hint to activate when the license has no session on this device yet.
Profile The signed-in account: name, email, roles and organization.

There is no admin surface: an end user can’t see other users’ licenses or change anything beyond their own activations.

My Licenses lists the entitlements on which the user is assigned as a principal. Assign (or remove) users on the entitlement’s Assigned users tab in the Provision Portal, or through the admin API — POST /api/v1/provision/admin/entitlements/{entitlementId}/principals/{principalId} — see the REST API reference. Once assigned:

  • the entitlement appears in that user’s My Licenses, and
  • interactive-user activation resolves against it, so an application the user signs in to can activate without you distributing an activation code — with exactly one assigned entitlement, no code is needed at all.

Activation codes work in parallel: the Activate page redeems a code the same way the SDK does, so you can hand a code to a user who prefers to self-serve.

By default the portal is invite-only, but you control this: Settings → User portal sets who may create an account. (Admin)

  • Closed (default) — no self-signup; you create users in the Provision Portal.
  • Open — anyone may register an account.
  • License required — an activation code Oclavex generated admits the person. Codes imported from elsewhere, or typed in by hand, are refused. The code is checked, never consumed — signing up doesn’t spend an activation, so one code admits as many accounts as it reaches until you delete it.

Independently, you can require approval: new sign-ups land in the Users approval queue as pending until someone lets them in. Oclavex operators can also suspend self-signup platform-wide; when that’s in effect the portal shows a notice on the sign-up page.

The person exists under Customers → Users in the Provision Portal and is approved — either created by you or self-registered where you allow it (above) — see account & team and, for approving or unblocking, support tasks.