Skip to main content
Staff only

Managing a tenant’s gateway connection

A gateway connection federates one tenant to an identity provider, so its users sign in through their own organisation’s provider. A tenant can have exactly one.

What you'll need
  • The Tenants module visible in your left-hand navigation.
  • A tenant that is not Offboarding or Deleted, and the provider’s details to hand.

If Tenants isn't in your navigation, your role doesn't have visibility for it — ask a workspace administrator, or see Permissions and module visibility.

Steps​

  1. Select Tenants from the Available Apps menu, open the tenant, then select Gateways in the settings sidebar.

  2. Select Add Gateway. In the New Gateway Connection drawer, enter a Connection Name; Tenant and the Keycloak alias (the tenant’s subdomain) are read-only.

  3. Choose a Provider Type: Microsoft Entra, Google, Okta (the default), Generic SAML or Generic OIDC. Changing it swaps the fields below and clears them.

  4. Fill every field under Provider Configuration — all are required. Most take Client ID and Client Secret; Microsoft Entra adds Tenant ID, Okta and Generic OIDC an Issuer URL, Generic SAML only a Metadata URL.

  5. Select Create. It reads Saving…, then Gateway connection created successfully! confirms it.

What success looks like​

  • Gateway connection created successfully! appears.
  • The row shows under Gateway with its ALIAS, PROVIDER and STATUS Enabled — the tenant’s users can sign in through it.

Changing or removing a connection​

Row Edit opens Edit Gateway Connection: Alias and Provider Type are fixed, but the Connection Name, the configuration fields and the Enabled toggle (Allow new logins via this provider.) can change — then Save Changes. Row Disable confirms, after which users can no longer sign in through the connection; the Enabled toggle brings it back. Row Delete removes it and its configuration for good.

If something goes wrong​

SymptomLikely causeWhat to do
Add Gateway greyed out.The tenant already has a connection.Edit that one instead.
Create stays disabled.An empty field, or a malformed URL.A URL field shows Enter a valid URL, including https:// until it parses.
Could not create the gateway connection. Please try again.The request was refused.The message stays in the drawer — fix the form, select Create again.
No Add Gateway and no ACTIONS column.The tenant is Offboarding or Deleted: read-only.Nothing on it can be changed here.

Next​

Steps verified against elie-staff-ui 0.1.0 on . Something wrong with this page?