Setting up OKTA for OIDC-based Single Sign-On (SSO)
Who is this article for?
Administrators responsible for managing organization security settings in Mazlan Home.
Admin Console access is required.
You can set up Okta as your corporate identity provider (IdP) in Mazlan Home using SAML or OIDC. To use an external identity provider like Okta, you will need to ensure the Mazlan Home user's authentication type is set to External.
This article outlines how to configure a new OIDC app in Okta and link it to Mazlan Home.
Creating an OIDC app
To create an OIDC app in Okta:
- Sign in to your Okta admin console.
- Navigate to Applications.
- Click Create App Integration.
- Select OIDC - OpenID Connect as the Sign-in method.
- Select Web Application.
- Click Next.
- In the General Settings step, enter an App name.
- For Core grants, ensure Authorization Code is ticked.
- Complete the rest of the configuration steps.
Configuring the OIDC app
Mazlan Home
To configure your OIDC IDP in Mazlan Home:
- Sign in to Mazlan Home.
- Navigate to the Admin Console.
- Go to the Security Center.
- Select Authentication.
- Select External IDP Configuration.
- Click Add Identity Provider.
- Select OIDC.
- Click Next.
- Take note of the Redirect URI displayed in the section at the top..
- Enter a Provider name.
This name will appear as the sign-in button label at the sign-in page. - Complete the remaining mandatory settings.
- Click Apply Configuration to save the IDP configuration in Mazlan Home.
Okta
To configure your OIDC IDP in Okta:
- Go to your Okta application.
-
After selecting the grant type, enter the Redirect URI copied from Mazlan Home.
-
Select the appropriate Assignment controlled access option.
For example, you could allow everyone in your organization to access.
Note
If you skip group assignment, you will still need to complete the assignment later on.
- Click Save to save the app.
Setting the Client ID and secret
Okta
In Okta, after you have saved your app, you will be presented with the Client ID and Client Secret. Take note of these values as you will need to set this up in Mazlan Home.
Mazlan Home
To configure the client information:
- Go to the OIDC Configuration screen.
- Paste in the Client ID.
- Paste in the Client secret.
Defining the authorized scope
In Mazlan Home, you will need to configure the required authorized scope.
Mazlan Home only populates openid by default. You will need to populate the additional scope as required, separated with spaces.
Refer to this page ID token claims reference - Microsoft identity platform for information on the scope required for each claim.
For example, you will need to add:
- profile scope to use the preferred_username claim
- email scope to use the email claim
- profile scope to use the name claim.
Setting the attribute request method
In Mazlan Home, select the GET request method for the attribute request method. This is the method recommended by Okta.
Getting the Issuer URL
Okta
You will need to obtain the Issuer URL from Okta to be set up in Mazlan Home.
To get the URL:
- Go to the Admin Console.
- Select Security.
- Click API.
- Switch to the Authorization Servers tab.
- Take note of the Issuer URI value.
Mazlan Home
To configure the URL:
- Go to the OIDC Configuration screen.
- Select Auto fill through issuer URL.
- Enter the Issuer URI obtained from Okta.
Mapping attributes
Mazlan Home
Based on the authorized scopes, several ID token claims can be mapped as OpenID Connect attributes to Mazlan Home user pool attributes, such as preferred_username and email.
To map the attributes:
- Go to the OIDC Configuration screen.
- Scroll to the bottom section for the attributes mapping.
- Enter the claim name from Okta to be mapped to the Mazlan Home user pool attribute.
- Click Apply Configuration to save changes.
Assigning users
You must assign users to the OIDC app in Okta before they can authenticate with your identity provider, if this was not done during initial setup.
Okta
To assign users to an OIDC app:
Go to the OIDC application.
Switch to the Assignments tab.
Click Assign.
You can either Assign access to People or Groups depending on your organization's needs.Search for the username or group you want to assign.
Click Save and Go Back after assigning every required user or group.
Click Done to apply changes.