Submit a ticket My Tickets
Welcome
Login  Sign up

Creating users via the API

Users can be created by calling the POST /api/v2.1/User endpoint.

The following roles are supported in the API:

User RoleRole ID
Learner1
Trainee Assessor4
Assessor / Tutor5
IV / IQA10
Employer40
Observer45

When creating learners, there are more required fields, than when create any other type of user. The required fields are shown below:

Create User (Learner)
POST /api/v2.1/User

{
"OrganisationID": {Id}
     "First Name": {First Name}
     "Last Name": {Last Name}
     "Role": 1
     "DefaultAssessorID": {Id}
     "ClassroomID": {Id}
     "PlacementID": {Id}
}
Create User (All Others)
POST /api/v2.1/User

{
     "OrganisationID": {Id}
     "First Name": {First Name}
     "Last Name": {Last Name}
     "Role": {Role}
}

Login Details

When the centre setting below is disabled, the API will return the user's UserID, username and password in the body of the response.

When the centre setting below is enabled, the API will only return a 200 OK status. The account will be added to a new/existing Keychain and the user will receive an email to verify their account.


 When creating new accounts, automatically create a new Keychain or attach to an existing Keychain when an email is supplied

A
Adam is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.