Using API to enable or disable users

Question

Has anyone tried enabling or disabling users using the API? We need to automate the process of disabling users who haven't been active for a year and enabling them again if they rejoin the organization. Additionally, we'd like to integrate this functionality with our service portal to handle requests automatically.

chackbusch · Answer

Hi@subbadaju. It depends a little bit on which information you have about the users and which integration capabilities you have.For the deactivation of inactive users, I would set up some daily/weekly execution:Read all users of your brands with the list users API.Based on the user IDs you receive from step 1, execute the get user API request for each of them. This provides you a property calledlastLoginDate based on which you can identify users that are inactive for at least 1 year. Ignore those whoseaccountStatus property is not active as they have already been deactivated.Use the update user API to update the users identified in step 2. Set the status property todisabled. If you just want to temporarily disable themIf you want to reactive a user, you can use theupdate user API and set the status property to active. If you do not have the Qualtrics internal user ID at this point, you can start the process again with thelist users APIand identify the relavant user e.g. based on the email property.The manage user guide is pretty the same as the single API documentations, but provides some more details such as available status values.BestChristian

Sign up

Login to the Community

Scanning file for viruses.

This file cannot be downloaded