October 4, 2022 - Release Notes

Overview

Click Boarding's Production environment will be down for scheduled maintenance and the promotion of new code on Tuesday, October 4, 2022 starting at 12:00AM CDT.

Table of Contents

• API Updates
  • Candidates/Users - GET Addition
  • Candidates/Users/{userApiIdentifier} - GET Addition
  • Candidates/Users/{userApiIdentifier} - PATCH Addition
  • Candidates - GET Update
  • Candidates - POST Update
  • Candidates/{id} - GET Update
  • Candidates/{id} - PATCH Update
  • Users - GET Update
  • Users - POST Update
  • Users/{id} - GET Update
  • Users/{id} - PATCH Update
• Team Member Page Update
• Admin Portal Menu Icons Update

API Updates

Candidates/Users - GET Addition

A new endpoint has been added called Candidates/Users - GET. The response to this call returns a list of all candidates and the following data points:

• userApiIdentifier - This is the Click Boarding platform's unique identifier representing the user.
• ssoIdentifier - This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a candidate in the SAML assertion. If ssoIdentifier has not been set for a candidate, the node will not appear for that candidate. Please note that this value is not used in the Auth0 implementation of SAML SSO.
• actions - This node outlines additional actions that can be completed with this candidate.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Candidates/Users/{userApiIdentifier} - GET Addition

A new endpoint has been added called Candidates/Users/{userApiIdentifer} - GET. The response to this call returns a the following data points for a single candidate:

• userApiIdentifier - This is the Click Boarding platform unique identifier representing the user.
• ssoIdentifier - This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a candidate in the SAML assertion. If ssoIdentifier has not been set for a candidate, the node will not appear for that candidate. Please note that this value is not used in the Auth0 implementation of SAML SSO.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Candidates/Users/{userApiIdentifier} - PATCH Addition

A new endpoint has been added called Candidates/Users/{userApiIdentifer} - PATCH. The request allows user to update the ssoIdentifer for a single candidate. The ssoIdentifer value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a candidate in the SAML assertion. Please note that this value is not used in the Auth0 implementation of SAML SSO.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Candidates - GET Update

The response to the Candidates - GET API call returns results ordered by RowID to be consistent with how the Candidate List in the Admin portal returns results.

In addition, the response to the Candidates - GET API call returns a userInfo node containing:

• userApiIdentifier - This is the Click Boarding platform unique identifier representing the user.
• ssoIdentifier - This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a candidate in the SAML assertion. If ssoIdentifier has not been set for a candidate, the node will not appear for that candidate. Please note that this value is not used in the Auth0 implementation of SAML SSO.
• actions - This node outlines additional actions that can be completed with this candidate.

Please note that this should not impact existing integrations using this call.

This is Click Boarding's recommended API call for getting userApiIdentifier and/or ssoIdentifier for the entire population.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Candidates - POST Update

The request for Candidates - POST API call accepts a userInfo node that can contain the candidate's ssoIdentifer. This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a candidate in the SAML assertion. Please note that this value is not used in the Auth0 implementation of SAML SSO.

Please note that this should not impact existing integrations using this call.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Candidates/{id} - GET Update

The response to the Candidates/{id} - GET API call returns a userInfo node containing:

• userApiIdentifier - This is the Click Boarding platform unique identifier representing the user.
• ssoIdentifier - This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a candidate in the SAML assertion. If ssoIdentifier has not been set for a candidate, the node will not appear for that candidate. Please note that this value is not used in the Auth0 implementation of SAML SSO.

Please note that this should not impact existing integrations using this call.

This is Click Boarding's recommended API call for getting userApiIdentifier and/or ssoIdentifier for a single candidate.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Candidates/{id} - PATCH Update

The request for Candidates/{id} - PATCH API call accepts a userInfo node that can contain the candidate's ssoIdentifer. This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a candidate in the SAML assertion. Please note that this value is not used in the Auth0 implementation of SAML SSO.

Please note that this should not impact existing integrations using this call.

This is Click Boarding's recommended API call for updating ssoIdentifier for a candidate.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Users - GET Update

The response to the Users - GET API call now returns ssoIdentifier for team members. This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a team member in the SAML assertion. If ssoIdentifier has not been set for a team member, the node will not appear for that team member. Please note that this value is not used in the Auth0 implementation of SAML SSO.

Please note that this should not impact existing integrations using this call.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Users - POST Update

The request for Users - POST has been updated to accept a new boolean property called sendFirstTimeLoginLink to send first-time login links to newly created Users.

• True = send an email to the newly created User.
• False OR When sendLoginLink is not present = email will not be sent.

A second boolean property called active has been added.

• True = user is active
• False = user is not active

The request for Users - POST API call accepts a team member's ssoIdentifer. This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a team member in the SAML assertion. Please note that this value is not used in the Auth0 implementation of SAML SSO.

Please note that this should not impact existing integrations using this call.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Users/{id} - GET Update

The response to the Users/{id} -GET call has been updated to allow location information to be easily retrievable using this call.

• There is a new node called locationGroups. This contains an array of location groups IDs and Names the user has access to.
• A second node called locations has been added that shows specific the location ID(s) and location name(s) of the locations the user has access to.
• A third node has been added called accessToAllLocations
  • True = User has access to all locations
  • False = User does not have access to all locations

The response now returns accessLevelId which corresponds to the access level the user has.

The response to the Users/{id} - GET API call now returns ssoIdentifier for a team member. This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a team member in the SAML assertion. If ssoIdentifier has not been set for a team member, the node will not appear for that team member. Please note that this value is not used in the Auth0 implementation of SAML SSO.

Please note that this should not impact existing integrations using this call.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Users/{id} - PATCH Update

The Users/{id} - PATCH has been update to more closely align with the Users - POST. Changes include being able to update:

• accessLevelId
• locationGroups
• locations

The request for Users/{id} - PATCH API call accepts a team member's ssoIdentifer. This value is only used if Click Boarding's SAML SSO is implemented. This field can be used as the nameId to uniquely identify a team member in the SAML assertion. Please note that this value is not used in the Auth0 implementation of SAML SSO.

Please note that this should not impact existing integrations using this call.

For more information or to try the call for yourself, please visit our Developer Portal at https://developer.clickboarding.com/. 

Team Member Page Update

The Location search on the Team Member page filtering option has been updated. The search values will appear correctly.

Admin Portal Menu Icons Update

The icons in the left menu of the Admin Portal have been updated. The order of the sections remains the same.

• Check icon = Action Center
• User icon = Candidates
• Clipboard icon = Processes & Content
• Building icon = Company
• Dataflow icon = Integrations