Request: POST /user
Permissions to Run the Request
...
Department Administrators and users with a custom role can add users only to the departments they manage and their sub-departments.
Request Headers and Parameters
| Header | Description |
|---|
| Authorization |
| (required) | Access token. You can |
obtain | by making a request |
| Parameter | Description |
|---|
| 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: |
| false) | The parameter that determines whether an email is sent to the added user |
| invitationMessage (optional, required if the |
| sendLoginEmail parameter is set to |
| true) | The text of the email invitation message that is sent to the added user |
| sendLoginSMS (optional, default: |
| false) | The parameter that determines whether an SMS is sent to the added user |
| invitationSMSMessage (optional, required if the |
| sendLoginSMS parameter is set to |
| true) | The text of the SMS that is sent to the added user |
| role (optional) | If you assign one of |
to the user (except for Account Owner), use one of the following values for the |
parameter: - account_administrators
- department_administrators
- course_authors
- learners
- supervisor
Learn more about using the |
section
|
| roleId (required if |
parameter is used, if you assign |
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 |
section
|
manageableDepartmentIds (required if the user's role is Department Administrator, |
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, or |
Response Parameters
Parameter | Description |
|---|
| user_id | The ID of the added user |
| Info |
|---|
Important Info- 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.
- The user role can be assigned in one of two ways:
- Using the role
|
...
...
...
- Department Administrator, or
|
...
...
...
...
- a custom role) tags,
- Using the
|
...
...
- array of data.
- If you use the
|
...
...
- 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, or
|
...
- a custom role).
If you add two administrative roles to the roles
|
...
- array of data, the user won't be added.
- If you have assigned a user role
|
...
...
...
...
...
- 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.
- If you haven't specified the user role with the role/roleId
|
...
...
- array of data, the user will be assigned to the
|
...
...
Possible Response Codes
| Code | Text | Description |
|---|
| 200 | OK | A new user has been added. The response body contains the ID of the added user |
| 400 | Bad Request | Some of the sent parameters are incorrect |
| 401 | Unauthorized | An authorization error |
| 403 | Permission Denied | The user doesn't have enough permissions to add other users. For instance, |
Department Administrators |
can't add users to a department they don't manage |
Sample Request
| Code Block |
|---|
|
POST /user https/1.1 |
...
Host: api-learn.ispringlearn.com |
...
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE |
...
Content-Type:application/xml |
...
...
...
...
<request>
<departmentId>1b7270ce-5cf5-11e9-a78e-0a580af40692</ |
...
departmentId>
<password>password</password>
<fields>
<login>kate.smith</login>
<phone>+19101231232</phone>
<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>
<invitationMessage>Please use the following credentials to sign up at iSpring Academy:
</invitationMessage>
<sendLoginSMS>true</sendLoginSMS>
<invitationSMSMessage>Please use the following credentials to sign up at iSpring Academy:
</invitationSMSMessage>
</request> |
Sample Response
| Code Block |
|---|
|
https/1.1 200 OK
<?xml |
Sample Response
...
...
...
<response>{user_id string}</ |
...