Objective
Determine specific user attributes that will be incorporated into the SSO process by configuring SSO claims.
Available Claims
The following attributes are communicated through claims from your identity provider.
Description |
Claim Name |
Required (Y/N) |
Default |
Notes |
First Name |
first_name |
N |
n/a |
n/a |
Last Name |
last_name |
N |
n/a |
n/a |
N |
n/a |
n/a |
||
External ID |
external_id |
N |
n/a |
n/a |
Job Title |
job_title |
N |
n/a |
n/a |
Language |
language |
N |
en |
Can be one of the following:
|
Location |
locations |
N |
n/a |
Assigns a location/locations to the user.
Use a comma separated list of location external IDs.
NOTE: If this claim is present but empty, the user's location(s) is/are removed. |
Role |
role |
N |
10 |
Can be one of the following:
|
Staff Group |
group |
N |
n/a |
For use in conjunction with staff groups.
Value is the staff group's external ID.
NOTE: If this claim is present but empty, the user's group is removed. |
Username |
username |
N |
nameId |
For more information, please refer to this article. |
External Role ID |
externalRoleId |
N |
n/a |
This claim can be used to support role mapping between Coconut and existing roles at your organization.
For more information, please refer to this article. |
Claims marked as required are required only at the time the user is created. To allow new users to be created when logging into Coconut through SSO:
From the navigation menu, click Settings
Click SSO
Expand Login Settings
Toggle on the Users logging in via SSO… setting to Users logging in via SSO that don’t already exist in Coconut will be created and logged in successfully
Steps
The steps to configure SSO claims vary depending on Identity Provider (IDP). Click the name of your IDP (if applicable) to be directed to additional information:
For additional information on nameID formats, please refer to this article.
Hot Tip!
If a user already exists in Coconut (for example, from being created through an Active Directory import), SSO only updates the role value (name, job title, email, username, and language do not change)
A note on access and visibility
Admin users can access Settings and configure the SSO integration settings in Coconut.