Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 3 KB

README.md

File metadata and controls

70 lines (47 loc) · 3 KB

UniFi Identity Enterprise (UID)

1. UID Application Configuration

Step 1: Log in to the Identity Enterprise Workspace

  1. Access the UID workspace (e.g., https://your-site.ui.com).
  2. Log in with your credentials.

UID Workspace

Step 2: Create a new application

  1. Select the Manager Portal. You will be prompted to verify with MFA.

  2. Select SSO Apps in the left-hand menu.

  3. Press the Plus button in the top right-hand corner.

  4. Select Add Custom App

  5. Select OIDC from the menu

  6. Fill in the details for your application. The required fields needed are Initiate Sign-In URI and Sign-In Redirect URI.

    Initiate Sign-In URI - (e.g., https://voucher.example.com) Sign-In Redirect URI - (e.g., https://voucher.example.com/oidc/callback)

  7. Press Add. You will now be presented with your Tool Collection for the app. Copy your Client ID, Client Secret and the value form your Well Known Config Endpoint.

  8. Press Done. You can now assign users or groups to the application. The setup has been completed UID side.

UID Manager Portal UID SSO Apps UID Custom App UID OIDC UID Add OIDC App UID Tool Collection App

2. UniFi Voucher Site Configuration

Now, configure your UniFi Voucher Site to use the UID client.

  1. In your UniFi Voucher Site configuration, set AUTH_OIDC_ENABLED to true.
  2. Set the AUTH_OIDC_CLIENT_ID as found within the UID Application.
  3. Provide the AUTH_OIDC_CLIENT_SECRET as found within the UID Application.
  4. Provide the AUTH_OIDC_ISSUER_BASE_URL from your UID domain (e.g., https://your-site.ui.com/gw/idp/api/v1/public/oauth/your-secret-token/.well-known/openid-configuration).
  5. Provide the AUTH_OIDC_APP_BASE_URL from your UniFi Voucher Site instance (e.g., https://voucher.example.com).
  6. Restart the container after these changes

3. Testing and Troubleshooting

From UID Workspace

Navigate to the Applications section and select your application. This will launch the application. If you followed the steps correctly you should be able to access the voucher site without needing to authenticate.

UID App Launcher UID Demo Sign-In UID OIDC Sign-In Success

External Sign In from outside of UID

Notice: You will only be prompted for UID sign-in if you have not signed in within your predefined sign in policy in UID.

Access your application via the Initiate Sign-In URI this will prompt a new window to sign in to UID. Once you sign in you will be redirected back to your application.

UID Sign-In UID Demo Sign-In UID OIDC Sign-In Success

That's it you now have OIDC setup and can sign in to your application!