Okta SAML
Learn how to configure Okta SAML 2.0 for Hanzo KMS SSO.
Okta SAML SSO is a paid feature. If you're using Hanzo KMS Cloud, then it is it.
In Hanzo KMS, head to the Single Sign-On (SSO) page and select the General tab. Click Connect for SAML under the Connect to an Identity Provider section. Select Okta, then click Connect again.

Next, copy the Single sign-on URL and Audience URI (SP Entity ID) to use when configuring the Okta SAML 2.0 application.

In the Okta Admin Portal, select Applications > Applications from the navigation. On the Applications screen, select the Create App Integration button.

In the Create a New Application Integration dialog, select the SAML 2.0 radio button:

On the General Settings screen, give the application a unique name like Hanzo KMS and select Next.

On the Configure SAML screen, set the Single sign-on URL and Audience URI (SP Entity ID) from step 1.

If you're self-hosting Hanzo KMS, then you will want to replace
https://app.kms.hanzo.ai with your own domain.
Also on the Configure SAML screen, configure the Attribute Statements to map:
id -> user.id,email -> user.email,firstName -> user.firstNamelastName -> user.lastName

Once configured, select Next to proceed to the Feedback screen and select Finish.
Once your application is created, select the Sign On tab for the app and select the View Setup Instructions button located on the right side of the screen:

Copy the Identity Provider Single Sign-On URL, the Identity Provider Issuer, and the X.509 Certificate to use when finishing configuring Okta SAML in Hanzo KMS.

Back in Hanzo KMS, set Identity Provider Single Sign-On URL, Identity Provider Issuer, and Certificate to X.509 Certificate from step 3. Once you've done that, press Update to complete the required configuration.

Back in Okta, navigate to the Assignments tab and select Assign. You can assign access to the application on a user-by-user basis using the Assign to People option, or in-bulk using the Assign to Groups option.

At this point, you have configured everything you need within the context of the Okta Admin Portal.
Enabling SAML SSO allows members in your organization to log into Hanzo KMS via Okta.

Enforcing SAML SSO ensures that members in your organization can only access Hanzo KMS by logging into the organization via Okta.
To enforce SAML SSO, you're required to test out the SAML connection by successfully authenticating at least one Okta user with Hanzo KMS; Once you've completed this requirement, you can toggle the Enforce SAML SSO button to enforce SAML SSO.
We recommend ensuring that your account is provisioned for the application in Okta prior to enforcing SAML SSO to prevent any unintended issues.
In case of a lockout, an organization admin can use the Admin Login Portal in the /login/admin path e.g. https://app.kms.hanzo.ai/login/admin.
If you are only using one organization on your Hanzo KMS instance, you can configure a default organization in the Server Admin Console to expedite SAML login.
If you're configuring SAML SSO on a self-hosted instance of Hanzo KMS, make
sure to set the AUTH_SECRET and SITE_URL environment variable for it to
work:
AUTH_SECRET: A secret key used for signing and verifying JWT. This can be a random 32-byte base64 string generated withopenssl rand -base64 32.
SITE_URL: The absolute URL of your self-hosted instance of Hanzo KMS including the protocol (e.g. https://app.kms.hanzo.ai)
How is this guide?
Last updated on