To integrate Okta with Komodor for Single Sign-On (SSO) and role provisioning, please follow the steps outlined below. This guide includes detailed instructions for setting up Single Sign-On (SSO) and provisioning roles, along with important considerations regarding Komodor role assignment precedence.
Note: Only Okta administrators can add the Komodor application. If you are not an Okta administrator, please contact your Okta admin to have the application added.
Section 1: Adding the Komodor App Integration
- Navigate to Okta Admin Dashboard > Applications > Browse App Catalog
- Search for Komodor
- Select Komodor and click 'Add Integration'.
Enter an Application label, eg 'komodor' or 'komodorio'.
Note: This is for internal use only and will also be the nickname for the Okta Application.
- Click ‘Done’ to add the application.
Section 2: Configuring the Komodor App
- Within the Komodor app, go to the 'Sign On' tab and click ‘Edit’ in the Settings box.
- Under ‘Advanced Sign-on Settings’, enter the Account Name provided to you by Komodor Support. This will generally be your companyname
- Change the Application username format to Email
- Scroll up to the SAML 2.0 section and send the 'Metadata URL' to support@komodor.com to complete the SAML setup.
- Once Komodor Support has completed the configuration, you can begin to use Okta for SSO.
Section 3: Creating the Komodor Roles attribute
- Navigate to Directory -> Profile Editor
- Select the Komodor User profile
- Click the + Add Attribute button
- Enter the following details in the form:
- Data type: string array
- Display name: Komodor Roles
- Variable name: komodorRoles
- Attribute type: Group
- Group priority: Combines values across groups
- Click Save
Section 4: Configuring SAML Attributes for Role Mapping
- From the Okta Admin Dashboard, navigate to to the Applications -> Applications
- Select the Komodor / Komodorio app
- From the Sign on tab, click the Edit button in the Settings box
- Within the the SAML 2.0 section, Click the > icon to expand the Attributes (Optional) section
Add the following attribute and save the changes:
Name: komodorRoles
Value: appuser.komodorRoles
- Everything is now set to assign Komodor roles through Okta
Section 5: Assigning Roles to Users and Groups
A user’s Komodor role membership in Okta is determined by their Komodor app assignment type, which can be either Individual or Group:
- Group Assignment: Users inherit any Komodor roles assigned to the Okta groups they are members of.
- Individual Assignment: Users inherit only the Komodor roles explicitly assigned to them as individuals. They do not inherit any roles associated with their groups.
When assigning Komodor roles to individuals or groups, Okta administrators can reference roles using either the Komodor Role Name or Role ID:
- Komodor role name, e.g., 'admin', 'viewer', 'developer'
- Komodor role UUID, e.g., 'ecb36aec-23b4-4173-86c7-568a97ae0e68'
Important: Role names and role IDs must match exactly as they appear in Komodor -- any discrepancies will prevent role assignments from being applied correctly.
Komodor Role UUIDs are visible in the Komodor UI on the Role Settings tab under Organization Settings → Roles and can be retrieved via Komodor’s API.
Assigning Komodor Roles to Individuals
- Within the Okta Admin Dashboard, Navigate to Directory -> People
- Select the user you'd like to assign roles to
- If the Komodor / Komodorio application is not yet assigned to the Individual user:
- Click Assign Applications
- Assign the Komodor / Komodorio application to the user
- Add the relevant roles you'd like to assign to the user and save the changes
- Click Assign Applications
- If the Komodor / Komodorio application is already assigned to the user:
- Edit the Komodor / Komodorio application assignment
- Make the wanted changes and click Save
- Edit the Komodor / Komodorio application assignment
Assigning Komodor Roles to Groups
- Within the Okta Admin Dashboard, Navigate to Directory -> Groups
- Select the group that you'd like to assign the Komodor role to
- Navigate to the Applications tab
- If needed, Click the Assign Applications button to Assign the Komodor / Komodorio app to the Group
- Specify the Komodor Role Name or UUID you wish to assign to the group and click Save
Editing Komodor Roles for an existing Okta Group
- Go the the relevant group Applications tab and edit the Komodor / Komodorio application assignment
- Modify the assigned role IDs and save the changes
Adding Users to Groups
- Within the Okta Admin Dashboard, Navigate to Directory -> Groups
- Click the Assign People button
- Click the + button for each user you'd like to add to the group.
- Click Done once you're finished
Changing Komodor App Assignment from Individual to Group
If a user’s Komodor App Assignment is set to Individual, they will not inherit any Komodor roles from groups they are a member of. The following steps detail how to change a user’s App Assignment from Individual to Group:
- Navigate to Applications -> Applications
- Select the Komodor application and navigate to the Assignments tab
Note: When logging into Komodor using Okta SSO, a user's Komodor App assignment type (Individual or group) determines whether Individual or Group roles are applied to that user.
- To convert the assignment type from Individual to Group, click the Convert assignments button
- Select the users for whom you'd like to convert the assignment, and click Convert selected (alternatively you can click the Convert all assignments button)
- Going back to the previous screen, you can confirm that the assignment type for that user has changed:
Section 6: Handling Unrecognized SSO Users
If a user logs in to Komodor via Okta SSO and none of their Okta assigned Komodor Roles match an existing role in Komodor, by default they will not be assigned any roles. As an additional fallback measure to enhance security, we recommend that Komodor admins also configure an empty default role.
Steps to Create an Empty Default Role
- Create a Dummy Policy
- Create a policy that refers to non-existent resources. For example, use a cluster name with a single space (" ").
- Create a policy that refers to non-existent resources. For example, use a cluster name with a single space (" ").
- Create a Default Role:
- Create a default role (ensure the "default" checkbox is selected) that references the dummy policy created in step 1.
Delete the Dummy Policy:
After creating the default role, delete the dummy policy, leaving the role empty. Users assigned to this default role will see no resources in the Komodor GUI unless they are granted Komodor roles individually in Okta or inherit them via Okta groups.
Comments
0 comments
Please sign in to leave a comment.