Page tree
Skip to end of metadata
Go to start of metadata

Request: POST /user

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles

Department Administrators and users with a custom role can add users only to the departments they manage and their sub-departments.


Request Headers


HeaderDescription
X-Auth-Account-Url (required)The base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)

The login of Account Owner, Account Administrator, Department Administrator, or a user with a custom role

X-Auth-Password (required)The password of Account Owner, Account AdministratorDepartment Administrator, or a user with a custom role
ParameterDescription
email (optional)The email of the new user.
login (required)The login of the new user.
password (optional)The password of the new user. 
departmentId (required)The ID of the department the user will be added to.
sendLoginEmail (optional, default: true)The parameter that determines whether an email is sent to the added user.
invitationMessage (optional)The text of an invitation message in the email.
role (required)

If you assign one of the standard roles to the user (apart from Account Owner and Publisher), set one of the following values to the role parameter:

  • learner
  • department_administrator
  • administrator

If you assign one of the custom roles to the users, set the custom value to the role parameter. 

roleId (required if the user role is Publisher or a custom role)

The roleId parameter is used, if you assign one of the custom roles or the Publisher role to the user.

manageableDepartmentIds (required if the user's role is Department Administrator, Publisher, or a custom role)

An array with the IDs of the departments the user will manage.
groups (optional)An array with the IDs of the groups the user will be added to.

If in the account there are required user profile fields (apart from the fields of the 'Country' format), they should be also put into the request.


Possible Response Codes


CodeTextDescription
201Successful operationA new user has been added. The response body contains ID of the added user. 
400Bad RequestSome of the sent parameters are incorrect.
401UnauthorizedAn authorization error.
403Permission Denied

The user doesn't have enough permissions to add another users. For instance, Department Administrators can't add users to a department they don't manage.

 

Sample Request

POST /user HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: owner
X-Auth-Password: 12345Q
Content-Type:application/xml
 
<?xml version="1.0" encoding="UTF-8"?>
<request>
    <departmentId>1b7270ce-5cf5-11e9-a78e-0a580af40692</departmentId>
    <password>12345Q</password>
    <fields>  
       <login>kate.smith</login>
       <email>kate@gmail.com</email>
       <first_name>Kate</first_name>
       <last_name>Smith</last_name>
       <job_title>Sales Manager</job_title>
    </fields>  
    <role>custom</role>
    <roleId>209b9312-afb3-11e9-aaf2-dabe560e07b1</roleId>
    <manageableDepartmentIds>
        <id>b00ba37c-5b6f-11e9-bb45-0a580af40556</id>
        <id>aff46554-5b6f-11e9-80e4-0a580af40556</id>
    </manageableDepartmentIds>
    <groupIds>
        <id>270ebbfa-5f6f-11e9-878e-0a580af406fd</id>
    </groupIds>
    <sendLoginEmail>true</sendLoginEmail>
    <invitationMessage>string</invitationMessage>
</request>

Sample Response

HTTP/1.1 201 Successful operation
Connection: close
 
<?xml version="1.0" encoding="UTF-8"?>
<user_id>string</user_id>
  • No labels