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.
role (optional)

If you assign one of the standard roles to the user (except for Account Owner and Publisher), use one of the following values for the role parameter:

  • learner
  • department_administrator
  • administrator

If you assign the Publisher role or one of the custom roles to the users, use the custom value for the role parameter. 

Learn more about using the role parameter in the Important section.

roleId (required if the custom value is used for the role parameter)

The roleId parameter is used, if you assign or the Publisher role or one of the custom roles to the user. In this case, you will need to use the needed role ID for the roleId parameter.

Learn more about using the roleId parameter in the Important section.

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.
roles  (optional)An array of data using which you can assign one or two roles to a user. You will need to use the needed role ID for the roleId parameter inside the array.

If you assign two roles, one of them will be Learner, and the second role — one of the administrative roles (Account Administrator, Department Administrator, Publisher, or a custom role).

Learn more about using the roles parameter in the Important section.

Important: 

  1. 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.

  2. The user role can be assigned in one of two ways:

    1. Using the role (if the assigned role is Account Administrator, Department Administrator, or Learner) and roleId (if the role is Publisher or a custom role) tags,

    2. Using the roles array of data.

  3. If you use the roles array of data to assign a user role, you will be able to select two roles at once. 

    One of the roles will be Learner and the second role will be one of the administrative roles (Account Administrator, Department Administrator, Publisher, or a custom role).

    If you add two administrative role to the roles array of data, the user won't be added.

  4. If you have assigned a user role both with the role/roleId tags and the roles array of data, the user will be assigned to a role or roles specified in the roles array of data and the value specified in the role/roleId tags will be then ignored.

  5. If you haven't specified the user role with the role/roleId tags or with the roles array of data, the user will be assigned to the Learner role. 


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.smith@ispringsolutions.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>
    <roles>
       <role>
         <roleId>efb18a8e-7be7-11ea-a17c-9e2d25e528cc</roleId>
            <manageableDepartmentIds>
                 <id>783eee2e-7b51-11ea-ae7d-9e2d25e528cc</id>
            </manageableDepartmentIds>
       </role> 
       <role>
          <roleId>eaf02558-2ae1-11e9-8b17-0242ac13000a</roleId> 
       </role> 
    </roles>
    <sendLoginEmail>true</sendLoginEmail>
</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