SSO Identifier

Overview

SSO Identifier is critical field for single sign on. This field acts as the username for the user attempting to enter Click Boarding. This value must be unique to the record. That means that it must be unique in the tenant across Team Members AND Candidates. If you attempt to use an SSO Identifier that is already in use, you will receive an error message.

In technical terms, the SSO Identifier must match what is being sent in the SAML assertion for NameId. If the SSO Identifier in Click Boarding and the NameId in the assertion do not match, the user will not be able to enter Click Boarding. With this in mind it is crucial that users have the correct SSO Identifier. While we recommend the SSO Identifier match exactly what is being sent in the assertion, this field is not case sensitive.

Please note that the value used as SSO Identifier was agreed upon at the time of SSO implementation. Click Boarding can likely provide you the name of the value, but cannot provide what the value should be for an individual. For example, if the agreed value is EmployeeId, Click Boarding can tell you the SSO Identifier should be the user's EmployeeId, but cannot tell you John Smith's SSO Identifier should be ABC123.

Updating via UI

The SSO Identifier can be updated via the UI by accessing the Team Member or Candidate profile you wish to add the SSO Identifier to.

• For new Team Members: [Home] -> [Company] -> [Team Members] -> [Create Team Member]
• For existing Team Members: [Home] -> [Company] -> [Team Members] -> [Edit]
• For new Candidates: [Home] -> [Candidate List] -> [Add Candidate]
• For existing Candidates: [Home] -> [Candidate List] -> [Select Candidate] -> [Edit Personal Information]

Updating via Bulk Import

The SSO Identifier can be added via import by accessing the Bulk Import section of Click Boarding. Please note that at this time, Bulk Imports only supports creating new candidates or team members. Existing candidates and team members cannot be updated. A future enhancement will allow you to update candidates and team members via bulk import. For more information on bulk imports, please visit our Bulk Import Resource Center articles.

Updating via API

We offer a variety of endpoints to update the SSO Identifier via API. For more information regarding our API, please visit our developer portal. 

• For new Team Members: Users-POST
• For existing Team Members: Users/{id}-PATCH
• For new Candidates: Candidates-POST
• For existing Candidates: Candidates/{id}-PATCH