Users
Create , delete , update , and manage users using our api that offers a lot of
minipulation and features for users.
Create a new user
{Tenant endpoint}/users
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
name
|
YES
|
string
|
the name of the user to be created.
|
|
username
|
YES
|
string
|
unqiue username for the user to be created.
|
|
email
|
YES
|
email
|
unqiue email for the user to be created
|
|
role
|
OPTIONAL
|
array
|
array of integer that represent the roles that the user will
have.
|
|
groups
|
OPTIONAL
|
array
|
array of groups that the use will be in once he is created.
|
|
student_of
|
OPTIONAL
|
array
|
array of classroom that the use will student of once he is
created.
|
|
teacher_of
|
OPTIONAL
|
array
|
array of classroom that the use will teacher of once he is
created.
|
|
password
|
OPTIONAL
|
string
|
user's account password on out database.
|
Transfer users from your system
{Tenant endpoint}/students/transfer
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
data
|
YES
|
array
|
array of objects each object contains name , username and id
for every user (The id from your system).
|
Transfer users from your system with their roles
{Tenant endpoint}/students/transfer
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
data
|
YES
|
array
|
array of objects each object contains name as a text , username as a text , role name as a text and id
for every user (The id from your system).
|
Get all users
{Tenant endpoint}/users
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
No parameters required for this request.
|
Get all users with their lms id's (after transfering students from your database
to ours)
{Tenant endpoint}/lms-user/all
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
No parameters required for this request.
|
Get all users with their roles
{Tenant endpoint}/users/roles
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
No parameters required for this request.
|
Get all users with their groups
{Tenant endpoint}/users/groups
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
No parameters required for this request.
|
Get all users with their classrooms
{Tenant endpoint}/users/classrooms
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
No parameters required for this request.
|
Get a specific user
{Tenant endpoint}/users/{user_id}
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
user_id
|
YES
|
Integer
|
the id of the desired user to be get (send in the
url not in the body of the request).
|
Get a specific user with his roles
{Tenant endpoint}/users/{user_id}/roles
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
user_id
|
YES
|
Integer
|
the id of the desired user to be get (send in the
url not in the body of the request).
|
Get a specific user with his groups
{Tenant endpoint}/users/{user_id}/groups
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
user_id
|
YES
|
Integer
|
the id of the desired user to be get (send in the
url not in the body of the request).
|
Get a specific user with his classrooms
{Tenant endpoint}/users/{user_id}/classrooms
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
user_id
|
YES
|
Integer
|
the id of the desired user to be get (send in the
url not in the body of the request).
|
Update a user
{Tenant endpoint}/users/{user_id}
type : or (if you send data as form data)
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
user_id
|
YES
|
Integer
|
the id of the desired user to be updated (send in
the url not in the body of the request).
|
|
name
|
OPTIONAL
|
string
|
the name of the user to be created.
|
|
username
|
OPTIONAL
|
string
|
unqiue username for the user to be created.
|
|
email
|
OPTIONAL
|
email
|
unqiue email for the user to be created
|
|
role
|
OPTIONAL
|
string
|
name of role that the user will
have.
|
|
groups
|
OPTIONAL
|
array
|
array of groups that the use will be in once he is created.
|
|
student_of
|
OPTIONAL
|
array
|
array of classroom that the use will student of once he is
created.
|
|
teacher_of
|
OPTIONAL
|
array
|
array of classroom that the use will teacher of once he is
created.
|
|
password
|
OPTIONAL
|
string
|
user's account password on out database.
|
Delete a user
{Tenant endpoint}/users/{user_id}
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
user_id
|
YES
|
Integer
|
the id of the desired user to delete (send in the url not in the body of the
request).
|