Forum Discussion

jeffshurtliff's avatar
jeffshurtliff
Boss
3 years ago

Unable to change SSO ID of user with the API

Hey all, We need to update the SSO ID of our users systematically and I am writing a Python script to do so.  However, when attempting to do so in the API v1 using a POST call to the /users/id/{id}/...
API
Community API
Rest API
JoseL's avatar
JoseL
Khoros Alumni (Retired)

Hi jeffshurtliff,


I'm following up here from the Support case to close the loop for others with the same issue.

As mentioned in the ticket, we don't support the /users/id/{id}/sso_id/set endpoint using HTML methods, which is why our documentation doesn't mention it:

https://devdocportal.khoros.com/t5/Community-API-v1-Reference/bd-p/restv1docs?section=commv1&leaf-id=User.sso_id#User.sso_id

The only supported method is via Community Admin > Mod Tools > Edit Users:

https://community.khoros.com/t5/Single-Sign-On-SSO/Change-a-user-s-SSO-ID/ta-p/124139

This similar thread mentions using FreeMarker as a workaround:

https://community.khoros.com/t5/Developer-Discussion/Forcefully-assign-SSO-ID-to-a-user-via-API/m-p/315767

However, the FreeMarker method isn't supported and may not work in the future.

Since you have to update hundreds of SSO IDs, I'm glad our Professional Services team is helping with the new SSO ID mapping!

Thank you for reaching out to us about this issue.

 

All the best,

jeffshurtliff's avatar
jeffshurtliff
Boss
3 years ago

Thanks JoseL for the info.

To further close the loop on this, here is a FreeMarker function that I wrote a while back (also provided in the support case) that does work to update SSO IDs via the REST API, which our support team utilizes in a custom modal I built to fix duplicate users:

 

<#-------------------- Function: updateSsoId -------------------->
<#-- This function updates the SSO ID of a user with an API v1 POST call -->
<#function updateSsoId userId userSsoId>
  <#local result = {"successful": true, "message": ""} />
  <#if userId?is_number>
    <#local userId = userId?c />
  </#if>
  <#if userSsoId?? && userSsoId?is_string>
    <#attempt>
      <#local response = restadmin('/users/id/${userId}/sso_id/set?value=${userSsoId?url}')!{} />
      <#if response?? && response.status?? && response.status?is_string && response.status != "success">
        <#local result += {"successful": false} />
      </#if>
      <#if response.message?? && response.message?has_content>
        <#local result = {"successful": false, "message": "${response.message}"} />
      </#if>
    <#recover>
      <#local result += {"successful": false} />
    </#attempt>
  </#if>
  <#return result />
</#function>

 

So I guess the POST call is set up to only work when utilized within the restadmin FreeMarker directive and not through third-party API calls, which is disappointing but is what it is.

That said, I really hope the FreeMarker method doesn't get removed in a future release because at the moment we are utilizing it heavily and it would trip us up quite a bit to lose the functionality.

  • jeffshurtliff's avatar
    jeffshurtliff
    Boss
    3 years ago

    Just to further close the loop on this, I was able to accomplish what I wanted by leveraging the FreeMarker function from my comment above within a custom endpoint, which I was then able to call in my Python script to systematically update my list of users.