Rest API Documentation

1. List all users

1.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/' -X GET \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"

1.2. Response Fields

Path Type Description

Path	Type	Description
`[]`	`Array`	list of users
`[].login`	`String`	user login
`[].connectedToLdap`	`Boolean`	is user account connected to LDAP
`[].ldapAccountAvailable`	`Boolean`	does the account exist in LDAP
`[].active`	`Boolean`	ist the use account active (can user login)
`[].confirmed`	`Boolean`	is the user email confirmed
`[].email`	`String`	email address
`[].orcidId`	`String`	orcid identifier
`[].id`	`Number`	user unique id
`[].maxColor`	`color`	color used for drawing data overlays with max value
`[].minColor`	`color`	color used for drawing data overlays with min value
`[].neutralColor`	`color`	color used for drawing data overlays with 0 value
`[].simpleColor`	`color`	color used for drawing data overlays without value
`[].name`	`String`	first name
`[].surname`	`String`	last name
`[].removed`	`Boolean`	is the account removed
`[].termsOfUseConsent`	`Boolean`	did user agree to terms of use
`[].privileges`	`Array`	list of user privileges
`[].privileges[].objectId`	`String`	object id to which project has privilege
`[].lastActive`	`String`	datetime of the last activity in the active session
`[].privileges[].privilegeType`	`String`	type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

[]

Array

list of users

[].login

String

user login

[].connectedToLdap

Boolean

is user account connected to LDAP

[].ldapAccountAvailable

Boolean

does the account exist in LDAP

[].active

Boolean

ist the use account active (can user login)

[].confirmed

Boolean

is the user email confirmed

[].email

String

email address

[].orcidId

String

orcid identifier

[].id

Number

user unique id

[].maxColor

color

color used for drawing data overlays with max value

[].minColor

color

color used for drawing data overlays with min value

[].neutralColor

color

color used for drawing data overlays with 0 value

[].simpleColor

color

color used for drawing data overlays without value

[].name

String

first name

[].surname

String

last name

[].removed

Boolean

is the account removed

[].termsOfUseConsent

Boolean

did user agree to terms of use

[].privileges

Array

list of user privileges

[].privileges[].objectId

String

object id to which project has privilege

[].lastActive

String

datetime of the last activity in the active session

[].privileges[].privilegeType

String

type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

1.3. Sample Response

[ {
  "id" : 118,
  "login" : "test_user",
  "name" : "Eldon",
  "surname" : "Tremblay",
  "email" : "nathanael.kuhlman@gmail.com",
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ ],
  "active" : true,
  "confirmed" : false,
  "ldapAccountAvailable" : false,
  "lastActive" : "2026-05-12 23:12:01"
}, {
  "id" : 3,
  "login" : "anonymous",
  "name" : "",
  "surname" : "",
  "email" : null,
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ {
    "privilegeType" : "READ_PROJECT",
    "objectId" : "empty"
  } ],
  "active" : true,
  "confirmed" : true,
  "ldapAccountAvailable" : false,
  "lastActive" : null
}, {
  "id" : 1,
  "login" : "admin",
  "name" : "",
  "surname" : "",
  "email" : null,
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ {
    "privilegeType" : "READ_PROJECT",
    "objectId" : "empty"
  }, {
    "privilegeType" : "IS_ADMIN",
    "objectId" : null
  }, {
    "privilegeType" : "IS_CURATOR",
    "objectId" : null
  } ],
  "active" : true,
  "confirmed" : true,
  "ldapAccountAvailable" : false,
  "lastActive" : "2026-05-12 23:12:02"
} ]

2. Get specific user data

2.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_user' -X GET \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"

2.2. Path Parameters

Table 1. /minerva/api/users/{login}
Parameter	Description
`login`	user login

2.3. Response Fields

Path Type Description

Path	Type	Description
`login`	`String`	user login
`connectedToLdap`	`Boolean`	is user account connected to LDAP
`ldapAccountAvailable`	`Boolean`	does the account exist in LDAP
`active`	`Boolean`	ist the use account active (can user login)
`confirmed`	`Boolean`	is the user email confirmed
`email`	`String`	email address
`orcidId`	`String`	orcid identifier
`id`	`Number`	user unique id
`maxColor`	`color`	color used for drawing data overlays with max value
`minColor`	`color`	color used for drawing data overlays with min value
`neutralColor`	`color`	color used for drawing data overlays with 0 value
`simpleColor`	`color`	color used for drawing data overlays without value
`name`	`String`	first name
`surname`	`String`	last name
`removed`	`Boolean`	is the account removed
`termsOfUseConsent`	`Boolean`	did user agree to terms of use
`privileges`	`Array`	list of user privileges
`privileges[].objectId`	`String`	object id to which project has privilege
`lastActive`	`String`	datetime of the last activity in the active session
`privileges[].privilegeType`	`String`	type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

login

String

user login

connectedToLdap

Boolean

is user account connected to LDAP

ldapAccountAvailable

Boolean

does the account exist in LDAP

active

Boolean

ist the use account active (can user login)

confirmed

Boolean

is the user email confirmed

email

String

email address

orcidId

String

orcid identifier

id

Number

user unique id

maxColor

color

color used for drawing data overlays with max value

minColor

color

color used for drawing data overlays with min value

neutralColor

color

color used for drawing data overlays with 0 value

simpleColor

color

color used for drawing data overlays without value

name

String

first name

surname

String

last name

removed

Boolean

is the account removed

termsOfUseConsent

Boolean

did user agree to terms of use

privileges

Array

list of user privileges

privileges[].objectId

String

object id to which project has privilege

lastActive

String

datetime of the last activity in the active session

privileges[].privilegeType

String

type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

2.4. Sample Response

{
  "id" : 111,
  "login" : "test_user",
  "name" : "Stewart",
  "surname" : "Monahan",
  "email" : "franklin.koelpin@yahoo.com",
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ ],
  "active" : true,
  "confirmed" : false,
  "ldapAccountAvailable" : false,
  "lastActive" : "2026-05-12 23:12:01"
}

3. Create user

3.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_login?name=Windy&surname=Walsh&password=21fphhs8g2' -X POST \
    -d 'name=Windy&surname=Walsh&password=21fphhs8g2' \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    -H 'Content-Type: application/octet-stream'

3.2. Path Parameters

Table 2. /minerva/api/users/{login}
Parameter	Description
`login`	user login

3.3. Form Parameters

Parameter Description

Parameter	Description
`name`	first name
`surname`	last name
`password`	user password
`email`	email address
`defaultPrivileges`	should the default privileges be added to the user after user creation

name

first name

surname

last name

password

user password

email

email address

defaultPrivileges

should the default privileges be added to the user after user creation

3.4. Response Fields

Path Type Description

Path	Type	Description
`login`	`String`	user login
`connectedToLdap`	`Boolean`	is user account connected to LDAP
`ldapAccountAvailable`	`Boolean`	does the account exist in LDAP
`active`	`Boolean`	ist the use account active (can user login)
`confirmed`	`Boolean`	is the user email confirmed
`email`	`String`	email address
`orcidId`	`String`	orcid identifier
`id`	`Number`	user unique id
`maxColor`	`color`	color used for drawing data overlays with max value
`minColor`	`color`	color used for drawing data overlays with min value
`neutralColor`	`color`	color used for drawing data overlays with 0 value
`simpleColor`	`color`	color used for drawing data overlays without value
`name`	`String`	first name
`surname`	`String`	last name
`removed`	`Boolean`	is the account removed
`termsOfUseConsent`	`Boolean`	did user agree to terms of use
`privileges`	`Array`	list of user privileges
`privileges[].objectId`	`String`	object id to which project has privilege
`lastActive`	`String`	datetime of the last activity in the active session
`privileges[].privilegeType`	`String`	type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

login

String

user login

connectedToLdap

Boolean

is user account connected to LDAP

ldapAccountAvailable

Boolean

does the account exist in LDAP

active

Boolean

ist the use account active (can user login)

confirmed

Boolean

is the user email confirmed

email

String

email address

orcidId

String

orcid identifier

id

Number

user unique id

maxColor

color

color used for drawing data overlays with max value

minColor

color

color used for drawing data overlays with min value

neutralColor

color

color used for drawing data overlays with 0 value

simpleColor

color

color used for drawing data overlays without value

name

String

first name

surname

String

last name

removed

Boolean

is the account removed

termsOfUseConsent

Boolean

did user agree to terms of use

privileges

Array

list of user privileges

privileges[].objectId

String

object id to which project has privilege

lastActive

String

datetime of the last activity in the active session

privileges[].privilegeType

String

type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

3.5. Sample Response

{
  "id" : 117,
  "login" : "test_login",
  "name" : "Windy",
  "surname" : "Walsh",
  "email" : null,
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ ],
  "active" : true,
  "confirmed" : true,
  "ldapAccountAvailable" : false,
  "lastActive" : null
}

4. Update user

4.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_user' -X PATCH \
    -d '{"user":{"password":"new pass"}}' \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    -H 'Content-Type: application/json'

4.2. Path Parameters

Table 3. /minerva/api/users/{login}
Parameter	Description
`login`	user login

4.3. Request Fields

Path Type Description

Path	Type	Description
`user.password`	`String`	user password
`user.connectedToLdap`	`Boolean`	is user account connected to LDAP
`user.ldapAccountAvailable`	`Boolean`	does is account exist in LDAP
`user.email`	`String`	email address
`user.maxColor`	`Object`	color used for drawing data overlays with max value
`user.minColor`	`Object`	color used for drawing data overlays with min value
`user.neutralColor`	`Object`	color used for drawing data overlays with 0 value
`user.simpleColor`	`Object`	color used for drawing data overlays without value
`user.name`	`String`	first name
`user.surname`	`String`	last name

user.password

String

user password

user.connectedToLdap

Boolean

is user account connected to LDAP

user.ldapAccountAvailable

Boolean

does is account exist in LDAP

user.email

String

email address

user.maxColor

Object

color used for drawing data overlays with max value

user.minColor

Object

color used for drawing data overlays with min value

user.neutralColor

Object

color used for drawing data overlays with 0 value

user.simpleColor

Object

color used for drawing data overlays without value

user.name

String

first name

user.surname

String

last name

4.4. Response Fields

Path Type Description

Path	Type	Description
`login`	`String`	user login
`connectedToLdap`	`Boolean`	is user account connected to LDAP
`ldapAccountAvailable`	`Boolean`	does the account exist in LDAP
`active`	`Boolean`	ist the use account active (can user login)
`confirmed`	`Boolean`	is the user email confirmed
`email`	`String`	email address
`orcidId`	`String`	orcid identifier
`id`	`Number`	user unique id
`maxColor`	`color`	color used for drawing data overlays with max value
`minColor`	`color`	color used for drawing data overlays with min value
`neutralColor`	`color`	color used for drawing data overlays with 0 value
`simpleColor`	`color`	color used for drawing data overlays without value
`name`	`String`	first name
`surname`	`String`	last name
`removed`	`Boolean`	is the account removed
`termsOfUseConsent`	`Boolean`	did user agree to terms of use
`privileges`	`Array`	list of user privileges
`privileges[].objectId`	`String`	object id to which project has privilege
`lastActive`	`String`	datetime of the last activity in the active session
`privileges[].privilegeType`	`String`	type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

login

String

user login

connectedToLdap

Boolean

is user account connected to LDAP

ldapAccountAvailable

Boolean

does the account exist in LDAP

active

Boolean

ist the use account active (can user login)

confirmed

Boolean

is the user email confirmed

email

String

email address

orcidId

String

orcid identifier

id

Number

user unique id

maxColor

color

color used for drawing data overlays with max value

minColor

color

color used for drawing data overlays with min value

neutralColor

color

color used for drawing data overlays with 0 value

simpleColor

color

color used for drawing data overlays without value

name

String

first name

surname

String

last name

removed

Boolean

is the account removed

termsOfUseConsent

Boolean

did user agree to terms of use

privileges

Array

list of user privileges

privileges[].objectId

String

object id to which project has privilege

lastActive

String

datetime of the last activity in the active session

privileges[].privilegeType

String

type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

4.5. Sample Response

{
  "id" : 110,
  "login" : "test_user",
  "name" : "Derick",
  "surname" : "Dicki",
  "email" : "cari.smitham@gmail.com",
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ ],
  "active" : true,
  "confirmed" : true,
  "ldapAccountAvailable" : false,
  "lastActive" : "2026-05-12 23:12:01"
}

5. Update user privileges

5.1. Path Parameters

Table 4. /minerva/api/users/{login}:updatePrivileges
Parameter	Description
`login`	user login

5.2. Request Fields

Path Type Description

Path	Type	Description
`privileges.*`	`Boolean`	should the privilege defined as PRIVILEGE_TYPE:ID_OBJECT be granted or not

privileges.*

Boolean

should the privilege defined as PRIVILEGE_TYPE:ID_OBJECT be granted or not

5.3. Response Fields

Path Type Description

Path	Type	Description
`login`	`String`	user login
`connectedToLdap`	`Boolean`	is user account connected to LDAP
`ldapAccountAvailable`	`Boolean`	does the account exist in LDAP
`active`	`Boolean`	ist the use account active (can user login)
`confirmed`	`Boolean`	is the user email confirmed
`email`	`String`	email address
`orcidId`	`String`	orcid identifier
`id`	`Number`	user unique id
`maxColor`	`color`	color used for drawing data overlays with max value
`minColor`	`color`	color used for drawing data overlays with min value
`neutralColor`	`color`	color used for drawing data overlays with 0 value
`simpleColor`	`color`	color used for drawing data overlays without value
`name`	`String`	first name
`surname`	`String`	last name
`removed`	`Boolean`	is the account removed
`termsOfUseConsent`	`Boolean`	did user agree to terms of use
`privileges`	`Array`	list of user privileges
`privileges[].objectId`	`String`	object id to which project has privilege
`lastActive`	`String`	datetime of the last activity in the active session
`privileges[].privilegeType`	`String`	type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

login

String

user login

connectedToLdap

Boolean

is user account connected to LDAP

ldapAccountAvailable

Boolean

does the account exist in LDAP

active

Boolean

ist the use account active (can user login)

confirmed

Boolean

is the user email confirmed

email

String

email address

orcidId

String

orcid identifier

id

Number

user unique id

maxColor

color

color used for drawing data overlays with max value

minColor

color

color used for drawing data overlays with min value

neutralColor

color

color used for drawing data overlays with 0 value

simpleColor

color

color used for drawing data overlays without value

name

String

first name

surname

String

last name

removed

Boolean

is the account removed

termsOfUseConsent

Boolean

did user agree to terms of use

privileges

Array

list of user privileges

privileges[].objectId

String

object id to which project has privilege

lastActive

String

datetime of the last activity in the active session

privileges[].privilegeType

String

type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

5.4. CURL sample 1

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_user:updatePrivileges' -X PATCH \
    -d '{"privileges":{"IS_ADMIN":true}}' \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    -H 'Content-Type: application/json'

5.5. Sample Response 1

{
  "id" : 119,
  "login" : "test_user",
  "name" : "Mike",
  "surname" : "Johnson",
  "email" : "booker.heller@hotmail.com",
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ {
    "privilegeType" : "IS_ADMIN",
    "objectId" : null
  } ],
  "active" : true,
  "confirmed" : true,
  "ldapAccountAvailable" : false,
  "lastActive" : "2026-05-12 23:12:01"
}

5.6. CURL sample 2

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_user:updatePrivileges' -X PATCH \
    -d '{"privileges":{"READ_PROJECT:test_project":true}}' \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    -H 'Content-Type: application/json'

5.7. Sample Response 2

{
  "id" : 115,
  "login" : "test_user",
  "name" : "Alena",
  "surname" : "Jenkins",
  "email" : "tomika.kovacek@hotmail.com",
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ {
    "privilegeType" : "READ_PROJECT",
    "objectId" : "test_project"
  } ],
  "active" : true,
  "confirmed" : true,
  "ldapAccountAvailable" : false,
  "lastActive" : "2026-05-12 23:12:01"
}

6. Delete user

6.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_user' -X PATCH \
    -d '{"user":{"password":"new pass"}}' \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
    -H 'Content-Type: application/json'

6.2. Path Parameters

Table 5. /minerva/api/users/{login}
Parameter	Description
`login`	user login

7. Request password reset over email

7.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_user:requestResetPassword' -X POST

7.2. Path Parameters

Table 6. /minerva/api/users/{login}:requestResetPassword
Parameter	Description
`login`	user login

8. Reset password using a token obtained over email

8.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users:resetPassword?token=80670070-2100-4202-9252-200944100763&password=pass2' -X POST \
    -d 'token=80670070-2100-4202-9252-200944100763&password=pass2' \
    -H 'Content-Type: application/octet-stream'

8.2. Form Parameters

Parameter Description

Parameter	Description
`password`	new password
`token`	reset password token obtained using email

password

new password

token

reset password token obtained using email

9. Register new user

9.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users:registerUser' -X POST \
    -d '{"password":"123qweasdzxc","surname":"Gawron","name":"Piotr","email":"piotr.gawron@uni.lu"}' \
    -H 'Content-Type: application/json'

9.2. Request Fields

Path Type Description

Path	Type	Description
`email`	`String`	user email (and login)
`password`	`String`	password
`name`	`String`	given name)
`surname`	`String`	family name

email

String

user email (and login)

password

String

password

name

String

given name)

surname

String

family name

9.3. Response Fields

Path Type Description

Path	Type	Description
`login`	`String`	user login
`connectedToLdap`	`Boolean`	is user account connected to LDAP
`ldapAccountAvailable`	`Boolean`	does the account exist in LDAP
`active`	`Boolean`	ist the use account active (can user login)
`confirmed`	`Boolean`	is the user email confirmed
`email`	`String`	email address
`orcidId`	`String`	orcid identifier
`id`	`Number`	user unique id
`maxColor`	`color`	color used for drawing data overlays with max value
`minColor`	`color`	color used for drawing data overlays with min value
`neutralColor`	`color`	color used for drawing data overlays with 0 value
`simpleColor`	`color`	color used for drawing data overlays without value
`name`	`String`	first name
`surname`	`String`	last name
`removed`	`Boolean`	is the account removed
`termsOfUseConsent`	`Boolean`	did user agree to terms of use
`privileges`	`Array`	list of user privileges
`privileges[].objectId`	`String`	object id to which project has privilege
`lastActive`	`String`	datetime of the last activity in the active session
`privileges[].privilegeType`	`String`	type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

login

String

user login

connectedToLdap

Boolean

is user account connected to LDAP

ldapAccountAvailable

Boolean

does the account exist in LDAP

active

Boolean

ist the use account active (can user login)

confirmed

Boolean

is the user email confirmed

email

String

email address

orcidId

String

orcid identifier

id

Number

user unique id

maxColor

color

color used for drawing data overlays with max value

minColor

color

color used for drawing data overlays with min value

neutralColor

color

color used for drawing data overlays with 0 value

simpleColor

color

color used for drawing data overlays without value

name

String

first name

surname

String

last name

removed

Boolean

is the account removed

termsOfUseConsent

Boolean

did user agree to terms of use

privileges

Array

list of user privileges

privileges[].objectId

String

object id to which project has privilege

lastActive

String

datetime of the last activity in the active session

privileges[].privilegeType

String

type of privilege, available values: IS_ADMIN, IS_CURATOR, READ_PROJECT

9.4. Sample Response

{
  "id" : 114,
  "login" : "piotr.gawron@uni.lu",
  "name" : "Piotr",
  "surname" : "Gawron",
  "email" : "piotr.gawron@uni.lu",
  "orcidId" : null,
  "minColor" : null,
  "maxColor" : null,
  "neutralColor" : null,
  "simpleColor" : null,
  "removed" : false,
  "connectedToLdap" : false,
  "termsOfUseConsent" : false,
  "privileges" : [ {
    "privilegeType" : "READ_PROJECT",
    "objectId" : "empty"
  } ],
  "active" : false,
  "confirmed" : false,
  "ldapAccountAvailable" : false,
  "lastActive" : null
}

10. Confirm email

10.1. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/api/users/test_user:confirmEmail?token=4996b659-1b7e-481f-8892-81e190e4f5c7' -X POST \
    -d 'token=4996b659-1b7e-481f-8892-81e190e4f5c7' \
    -H 'Content-Type: application/octet-stream'

10.2. Form Parameters

Parameter Description

Parameter	Description
`token`	token obtained in the registration email

token

token obtained in the registration email

10.3. Path Parameters

Table 7. /minerva/api/users/{login}:confirmEmail
Parameter	Description
`login`	user login

10.4. Response Fields

Path Type Description

Path	Type	Description
`message`	`String`	detailed information about the status
`status`	`String`	status

message

String

detailed information about the status

status

String

status

10.5. Sample Response

{
  "message" : "Your email is confirmed. You need to wait for admin approval before you can login",
  "status" : "OK"
}

Rest API Documentation - Users

1. List all users

1.1. CURL sample

1.2. Response Fields

1.3. Sample Response

2. Get specific user data

2.1. CURL sample

2.2. Path Parameters

2.3. Response Fields

2.4. Sample Response

3. Create user

3.1. CURL sample

3.2. Path Parameters

3.3. Form Parameters

3.4. Response Fields

3.5. Sample Response

4. Update user

4.1. CURL sample

4.2. Path Parameters

4.3. Request Fields

4.4. Response Fields

4.5. Sample Response

5. Update user privileges

5.1. Path Parameters

5.2. Request Fields

5.3. Response Fields

5.4. CURL sample 1

5.5. Sample Response 1

5.6. CURL sample 2

5.7. Sample Response 2

6. Delete user

6.1. CURL sample

6.2. Path Parameters

7. Request password reset over email

7.1. CURL sample

7.2. Path Parameters

8. Reset password using a token obtained over email

8.1. CURL sample

8.2. Form Parameters

9. Register new user

9.1. CURL sample

9.2. Request Fields

9.3. Response Fields

9.4. Sample Response

10. Confirm email

10.1. CURL sample

10.2. Form Parameters

10.3. Path Parameters

10.4. Response Fields

10.5. Sample Response