0

API3 breaking changes

With the release of 2023.14, API3 Beta is in its final preview release, ahead of its production release in the next subsequent version.

In 2023.14, some changes were made to functions, itemized below, that will break any prototypical code built using either the API3 REST or SDK libraries. All changes relate to the "ACCESS" function list - and were made to optimize the structure and remove duplication.

Name and Signature Changes

Old Function Name New Function Name
/API3/access/createUserAd /API3/access/createUsersFromSearch
/API3/access/createUserDb /API3/access/createUsers
/API3/access/createUserOpenId /API3/access/createUsers
/API3/access/createUsersAd /API3/access/createUsersFromSearch
/API3/access/createUserSaml /API3/access/createUsers
/API3/access/createUsersDb /API3/access/createUsers
/API3/access/createUsersOpenId /API3/access/createUsers
/API3/access/createUsersSaml /API3/access/createUsers
/API3/access/getGroupsByRole /API3/access/getRoleGroups
/API3/access/getUserByOpenIdPrincipalName /API3/access/getUserByPrincipalName
/API3/access/getUserBySamlPrincipalName /API3/access/getUserByPrincipalName
/API3/access/searchAdGroups /API3/access/searchExternalGroups
/API3/access/searchAdGroupsForUser /API3/access/searchUserGroups
/API3/access/searchAdUsers /API3/access/searchExternalUsers
/API3/access/searchAdUsersForGroups /API3/access/searchGroupUsers
/API3/access/updateUserAd /API3/access/updateUsersFromSearch
/API3/access/updateUserDb /API3/access/updateUsers
/API3/access/updateUserOpenId /API3/access/updateUsers
/API3/access/updateUsersAd /API3/access/updateUsersFromSearch
/API3/access/updateUserSaml /API3/access/updateUsers
/API3/access/updateUsersDb /API3/access/updateUsers
/API3/access/updateUsersOpenId /API3/access/updateUsers
/API3/access/updateUsersSaml /API3/access/updateUsers

Function Input Changes

function old input new input
/API3/access/searchExternalGroups LdapSearchObject ExternalSearchObject
/API3/access/searchUserGroups SearchAdUserGroupsData ExternalUserIdentifier
/API3/access/searchExternalUsers LdapUsersSearchObject ExternalSearchObject
/API3/access/searchGroupUsers SearchAdGroupUsersData ExternalGroupIdentifier

Function Output Changes

function old output new output
/API3/access/getUserByPrincipalName PyramidViewUserObject PyramidUserObject
/API3/access/getUser PyramidViewUserObject PyramidUserObject
/API3/access/getTenantUsersByUserType PyramidViewUserObject[] PyramidUserObject[]
/API3/access/getUsersByName PyramidViewUserObject[] PyramidUserObject[]
/API3/access/getUsersByRole PyramidViewUserObject[] PyramidUserObject[]
/API3/access/getMe PyramidViewUserObject PyramidUserObject
/API3/access/createUsers ModifiedItemsResult ModifiedUsersResult
/API3/access/updateUsers ModifiedItemsResult ModifiedUsersResult
/API3/access/createUsersFromSearch ModifiedItemsResult ModifiedUsersResult
/API3/access/updateUsersFromSearch ModifiedItemsResult ModifiedUsersResult

Reply

null

Content aside

  • 4 wk agoLast active
  • 104Views
  • 1 Following