Skip to main content

Setting up OpenID Connect

Updated over 2 months ago

OpenID Connect (OIDC) is a secure identity layer that allows members to authenticate and log in to their Member Portal with a single account, also known as Single Sign-On (SSO). OIDC provides a consistent login experience for the members of your organization.

This article describes how to link your OIDC provider with Kube.

NOTES:

  • Because of the complex nature of OIDC, this article does not cover the requirements of each provider and only the fields found in Kube. For assistance with your provider's setup, please contact their respective support team.

  • Not all OIDC providers are supported at this time. Please contact Yardi technical support for assistance in determining if your provider is supported.

  • Depending on your assigned role and permissions, and the version of Kube your organization uses, some or all of these menus or services may not be available or displayed.

Setting up OpenID Connect (OIDC) in Kube

  1. Select your Personal Profile in the top menu and select System Settings from the drop-down menu. The Operator Profile screen appears.

  2. Select Customer Portals in the side menu, then the Member tab. The Links/URL menu appears.

  3. Select the Authentication tab and then click the edit button.

  4. Select Yes in the Use OIDC Authentication field to turn the setting on.

  5. Complete the fields. See the end of this article for a screen reference.

  6. Click Save.

NOTE: After OIDC is set up, members see a prompt to log in with your organization's branding when logging into their Member Portal.

OpenID Connect (OIDC) setup screen reference

OIDC Provider Name

Name of your OIDC provider. This is displayed above the login button of your customer portals.

For example, if the name entered in this field is OIDC Provider Example, the label above the login button will be Log In with OIDC Provider Example.

OIDC Provider Image Link

The image displayed on the login button of your customer portals.

Well-Known Configuration Endpoint

Enter the full URL to your identity provider's endpoint. Kube uses this endpoint to automatically retrieve your provider's authentication settings.

For example, enter the first part of your domain https://your-domain. Kube has prefilled the remainder.

Client ID

Enter the unique identifier provided by your provider to identify the application during authentication.

Redirect URL

Enter the URL where the member should be sent after a successful login.
​
For example, enter #/app/dashboard if the member should land on the Home Page.

Did this answer your question?