Last modified on December 30, 2013 at 3:36 pm
Users are the records of login accounts (including student accounts as well as course administrator and organization administrator accounts) in the system which belong to your organization. This resource allows you to programmatically create new accounts, update properties and change passwords on existing accounts, and search and retrieve basic user account information.
You can get details of the JSON representation of users by checking the User Object Reference.
Resource At a Glance
At a high level, the following basic operation types for this resource are supported:
- GET — retrieve information about a user or many users
- POST — create a new user; requires JSON-formatted user information object. See use case example below.
- PUT — update properties or reset password for existing users. Partial object updates are supported.
- DELETE — remove a user account from the system.
Use Case Examples
|Retrieve all users||Retrieve a list of all your organization’s users and their basic user information.|
|Retrieve a specific user by id||Retrieve all data for a specific user.|
|Search for users by email address||Use the resource list filtering functionality to retrieve a list of the users with the given email address|
|Create a new user||Create a new user login account in your organization|
|Update basic user information||Modify basic user attributes like First Name, Last Name, and Tags|
|Change user email address||Update the email address the user uses to login to the system, as well as where the user’s notifications are sent|
|Reset user password||Change the password used by the user when logging in|
|Remove a user||Delete a user from your organization|