This page outlines the key concepts regarding users in EdApp, and the various endpoints available in the Users API.
Users API Overview
The EdApp Users API contains the following endpoints (click the links to see detailed documentation):
- POST /v2/users: Create a new user in your account
- GET /v2/users: Get all users in your account
- GET /v2/users/{userId}: Get a user in your account, by user id
- GET /v2/users/{userId}/courses: Get the list of courses a user has access to, by user id
- PUT /v2/users/{userId}: Update a user in your account, by user id
- DELETE /v2/users/{userId}: Delete a user from your account, by user id
Read on below for more details about users in EdApp.
Users in EdApp
Users are individuals with some access to the EdApp platform. Each user in EdApp is represented by a unique identifier (id) and has the following associated data:
- Username
- Password
- First and last name
- External id
- Roles
- User groups
- Managed user groups
- Custom fields
External Id
The external identifier field is an optional addition to a user's profile, useful for establishing a "link" between an EdApp user, and a user in an external system.
For example, you might store the id of the user from your database in this field to allow easier referencing of your users through the API.
External identifiers must be unique within your account.
User Roles
Depending on the user's role, they may be able to access the learners app (also available as an iPhone or Android app) and/or the admin portal (or specific functions of the admin portal - also called the LMS). The following is a list of the available user roles in EdApp.
Learners App Roles
These 2 roles create a fully functional leaner who can consume content within EdApp:
- app-user
- prizing-user
Admin Portal Roles
The following are roles associated with the admin portal:
- account-admin
- content-author
- manager-analytics
- exclude-from-analytics
- reviewer
User Groups
User groups in EdApp are used to sort and deliver content appropriately. For example, you could have a Sales user group to which all sales learning content is delivered.
The userGroups field in the API contains a list of user group ids.
Managed User Groups
Users with the manager-analytics role can perform basic analytics on user groups without access to other admin permissions.
The managedUserGroups field in the API contains a list of user group ids that the user manages.
Custom Fields
Custom fields are used in EdApp to assign variable values to users. These can be declared in the EdApp LMS and then assigned to users as a key-value pair.
For example, the field jobTitle could be used to store a user’s job title. This field can then be used in an EdApp dynamic user group to sort and deliver content automatically.