Users

Resource URL

https://api.digitalchalk.com/api/v5/users

Overview

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.

For information on accessing your organization’s custom userfield values associated with a user based on the User Fields you have defined, please see the documentation for Userfield Values.

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

GET Requests

Operation	Call	Description
Retrieve all users	GET /api/v5/users	Retrieve a list of all your organization’s users and their basic user information.
Retrieve a specific user by id	GET /api/v5/users/{id}	Retrieve all data for a specific user.
Search for users by email address	GET /api/v5/users?email={emailAddress}	Use the resource list filtering functionality to retrieve a list of the users with the given email address

POST Requests

Operation	Call	Description
Create a new user	POST /api/v5/users	Create a new user login account in your organization

PUT Requests

Operation	Call	Description
Update basic user information	PUT /api/v5/users/{id}	Modify basic user attributes like First Name, Last Name, and Tags
Change user email address	PUT /api/v5/users/{id}	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	PUT /api/v5/users/{id}	Change the password used by the user when logging in

DELETE Requests

Operation	Call	Description
Remove a user	DELETE /api/v5/users/{id}	Delete a user from your organization

Reference

• User Object Reference