Disable and enable Flow365 user accounts via API

With the Learn365 API, you can disable or enable Flow365 user accounts. If you disable a user account, they can’t sign in to the Training page until they get enabled again.

In this article, we describe the steps you should follow to disable or enable Flow365 user accounts via API.

 

NOTES 

  • By default, new Flow365 user accounts are enabled.
  • If you disable a Flow365 user account, the user account still counts in the overall number of Flow365 users in your subscription.

 

To disable or enable a Flow365 user account, you’ll need the user's ID. You can find this via the API by following the steps in this article.

To disable or enable a Flow365 user account:

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the Users section, select one of these requests:

  • POST /services/users/Users/{id}/Enable and POST /services/users/Users/{id}/Disable allow you to enable or disable a particular Flow365 user account. If you choose one of these requests, select Try it out in the top right-hand corner and enter a user ID in the id field.

    Disable a particular learner

  • POST /services/users/Users/Enable and POST /services/users/Users/Disable allow you to enable or disable multiple Flow365 user accounts with one request. If you choose one of these requests, select Try it out in the top right-hand corner and enter the user IDs in the request body array.

    Disable multiple learners

3. Select Execute to run the request.

4. Go to the Response block to check the results. For any of the four requests, the results are the same:

  • 200 code with an empty body indicates a successful response.
  • 404 code with an error description in its body indicates that a user with this ID hasn’t been found. Re-check the user ID and try again.
  • In case of other errors, the response body contains the error object with the code and message keys explaining the issue.

 

Was this article helpful?
1 out of 1 found this helpful

Comments

Article is closed for comments.