Create User

Create a User

POST 

https://rest.edapp.com/v2/users

Parameters

Parameter Description  Data Type
request 

JSON Body request

JSON


Request fields

Field Description  Data Type 

externalIdentifier

External Id’s are an optional addition to a user’s profile that allow for easier referencing of users through API.

String (nullable)

name

Username

string

password

Password string

email

User’s email

string

userGroups

User Groups are used in EdApp to sort and deliver content appropriately. For example, you could have a sales user group to which all sales learning content is delivered.

Array (nullable)

userGroupsManaged

Users with the manager- analytics role can perform basic analytics on user groups without access to other admin permissions. In this space a user can be assigned as a manager of certain user groups.

Array (nullable)

firstName

User’s first name

String (nullable)

lastName

User’s last name

String (nullable)

customFields

Custom fields are used in EdApp to assign variable values to users. These can be declared in the EdApp LMS and then assigned to any user as a key-value pair. For example, the field jobTitle could be used to declare a user’s job title. This field can then be used by our EdApp dynamic user groups to sort and deliver content automatically.

Array (nullable)

roles 

The EdApp system has users with various types and roles. The default roles for users created by this endpoint are app-user and prizing-user. These 2 roles create a fully functional learner who can consumer content within EdApp. Other roles include account-admin, content-author, manager-analytics, exclude- from-analytics, and reviewer.

Array (nullable)

sendWelcomeEmail

When set to true, the user will get a welcome email with the credentials. 
 
 Boolean

 

Request example

{
"externalIdentifier": "string",
"name": "string",
"email": "string",
"password": "string",
"firstName": "string",
"lastName": "string",
"userGroups": [
"string"
],
"userGroupsManaged": [
"string"
],
"roles": [
"string"
],
"customFields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
sendWelcomeEmail:true
}

Response

Field Description  Data Type 
id

Ed UserId

string

externalId

External Id’s are an optional addition to a user’s profile that allow for easier referencing of users through API.

string
name Username string
email

User’s email

string

userGroups

User Groups are used in EdApp to sort and deliver content appropriately. For example, you could have a sales user group to which all sales learning content is delivered.

Array

userGroupsManaged

Users with the manager- analytics role can perform basic analytics on user groups without access to other admin permissions. In this space a user can be assigned as a manager of certain user groups.

Array

firstName

User's first name 
 
string

lastName

User’s last name

string

customFields

Custom fields are used in EdApp to assign variable values to users. These can be declared in the EdApp LMS and then assigned to any user as a key-value pair. For example, the field jobTitle could be used to declare a user’s job title. This field can then be used by our EdApp dynamic user groups to sort and deliver content automatically.

Array
roles

The EdApp system has users with various types and roles. The default roles for users created by this endpoint are app-user and prizing-user. These 2 roles create a fully functional learner who can consumer content within EdApp. Other roles include account-admin, content-author, manager-analytics, exclude- from-analytics, and reviewer.

Array