Hiding Authentication Providers
Overview
Some auth providers are intended for a subset of users, such as Seeq support team members and administrators (Seeq SaaS Admin) or external users (see, e.g., Planning Seeq Access for External Users). To facilitate this, an advanced configuration Authentication/HiddenProviderIds can be set to hide authentication providers. This configuration is set to Seeq Saas Admin by default.
Usage
To use this feature:
Update the
Authentication/HiddenProviderIdsconfiguration in the Configuration tab of the Administration panel. Specify all providers (using datasourceId attribute) that should be hidden in a comma-delimited format. Example: Seeq, Seeq Saas Admin, {other auth provider datasourceId}For OAuth connections, update the
RedirectURIconfiguration parameter to include adirectoryIdparameter. TheRedirectURIshould follow the formathttps://<your seeq url>/login?directoryId=<your directory id>, where<your seeq url>should be replaced with your actual Seeq URL and<your directory id>with your actual directory ID.
Effects
Login Page
On the login page, providers that are specified in Authentication/HiddenProviderIds will not be available in the [Directory] dropdown.
This behavior can be bypassed by adding the directoryId query string to the login page URL.
Example
https://companyA.seeq.com/login- Default behavior. Any providers specified inAuthentication/HiddenProviderIdswill not show up in the [Directory] dropdown.
https://companyA.seeq.com/login?directoryId=Seeq- Ensures that Seeq directory is available, even if it is specified as a hidden provider.
Auth API
GET /auth/providers will only return providers that are not specified in the Authentication/HiddenProviderIds setting.
This behavior can be bypassed by specifying a query parameter includeAuthProviderIds using a comma-delimited format.
Example
GET https://companyA.seeq.com/api/auth/providers- Returns auth providers not specified inAuthentication/HiddenProviderIds.GET https://companyA.seeq.com/api/auth/providers?includeProviderIds=Seeq,Seeq Saas Admin- Return auth providers not specified inAuthentication/HiddenProviderIds, but also include Seeq and Seeq Saas Admin even if they are hidden.