Skip to main content
Configure SSO role mapping
Paul Sullivan avatar
Written by Paul Sullivan
Updated over 4 months ago

In this article

Objective

Map your organization’s roles to Coconut roles by configuring role mapping.

NOTE: Single Sign-On is an add-on feature. Please connect with your Customer Success Manager to get started.

Steps

To configure role mapping, roles will need to be mapped in Coconut and configured in your organization’s IDP.

Map roles in Coconut

  1. From the navigation menu, click Settings

  2. From Integrations & API, click SSO

  3. Expand User Role Mapping

  4. Enter the name of your organization's role in External Roles

  5. Select the corresponding Coconut role from Coconut Software Roles

SSO_role_mapping.png

Configure role mapping for your organization's roles by expanding User Role Mapping in your SSO Configuration

Complete additional configuration based on your IDP

Additional configuration may be required based on your IDP. For example, if using Entra ID, a relay state for each role ID needs to be included in the enterprise application in Entra ID.

For more information, please refer to your organization’s IDP’s documentation:

An example mapping using a SAML attribute

In this example, your organization uses Entra ID. You have a role at your organization for Team Lead that you want to map to Coconut’s Staff Advanced role.

In Entra ID, someone at your organization with admin access creates an additional claim using the following details:

Claim name

Type

Value

externalRoleId

SAML

"team_lead"

Then, in Coconut, an admin user completes the following role mapping in Settings>Integrations & API>SSO>User Role Mapping:

External Roles

Coconut Software Roles

team_lead

Staff Advanced

An example mapping using a relay state

In this example, your organization uses Entra ID. You have a role at your organization for Team Lead (role ID = Team_Lead) that you want to map to Coconut’s Staff Advanced role.

In Coconut, an admin user completes the following role mapping in Settings>Integrations & API>SSO>User Role Mapping:

External Roles

Coconut Software Roles

Team_Lead

Staff Advanced

In Entra ID, someone at your organization with admin access to Entra ID updates the SAML User Profile for Team_Lead to include a relay state. The relay state value = Team_Lead.

Once these actions are completed, the staff’s profile settings in Coconut will include the following details:

External ID

Role

Team_Lead

Staff Advanced

A note on access and visibility

Admin users can access Settings and configure role mappings.

Did this answer your question?