= Rest API Documentation - Users
minerva
v{project-version} {build-time}
:toc: left
:sectnums:

== List all users
=== CURL sample
include::{snippets}/user/list_users/curl-request.adoc[]

=== Response Fields
include::{snippets}/user/list_users/response-fields.adoc[]

=== Sample Response
include::{snippets}/user/list_users/response-body.adoc[]

== Get specific user data
=== CURL sample
include::{snippets}/user/get_user/curl-request.adoc[]

=== Path Parameters
include::{snippets}/user/get_user/path-parameters.adoc[]

=== Response Fields
include::{snippets}/user/get_user/response-fields.adoc[]

=== Sample Response
include::{snippets}/user/get_user/response-body.adoc[]


== Create user
=== CURL sample
include::{snippets}/user/create_user/curl-request.adoc[]

=== Path Parameters
include::{snippets}/user/create_user/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/user/create_user/request-parameters.adoc[]

=== Response Fields
include::{snippets}/user/create_user/response-fields.adoc[]

=== Sample Response
include::{snippets}/user/create_user/response-body.adoc[]


== Update user
=== CURL sample
include::{snippets}/user/update_user/curl-request.adoc[]

=== Path Parameters
include::{snippets}/user/update_user/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/user/update_user/request-parameters.adoc[]

=== Response Fields
include::{snippets}/user/update_user/response-fields.adoc[]

=== Sample Response
include::{snippets}/user/update_user/response-body.adoc[]

== Update user privileges
=== Path Parameters
include::{snippets}/user/update_privilege_1/path-parameters.adoc[]

=== Request Fields
include::{snippets}/user/update_privilege_1/request-fields.adoc[]

=== Response Fields
include::{snippets}/user/update_privilege_1/response-fields.adoc[]

=== CURL sample 1
include::{snippets}/user/update_privilege_1/curl-request.adoc[]

=== Sample Response 1
include::{snippets}/user/update_privilege_1/response-body.adoc[]

=== CURL sample 2
include::{snippets}/user/update_privilege_2/curl-request.adoc[]

=== Sample Response 2
include::{snippets}/user/update_privilege_2/response-body.adoc[]

== Update user preferences
=== Path Parameters
include::{snippets}/user/update_preferences_1/path-parameters.adoc[]

=== Request Fields
include::{snippets}/user/update_preferences_1/request-fields.adoc[]

=== Response Fields
include::{snippets}/user/update_preferences_1/response-fields.adoc[]

=== CURL sample 1
include::{snippets}/user/update_preferences_1/curl-request.adoc[]

=== CURL sample 2
include::{snippets}/user/update_preferences_2/curl-request.adoc[]

=== CURL sample 3
include::{snippets}/user/update_preferences_3/curl-request.adoc[]

=== CURL sample 4
include::{snippets}/user/update_preferences_4/curl-request.adoc[]

=== CURL sample 5
include::{snippets}/user/update_preferences_5/curl-request.adoc[]

=== Sample Response 5
include::{snippets}/user/update_preferences_5/response-body.adoc[]

== Delete user
=== CURL sample
include::{snippets}/user/update_user/curl-request.adoc[]

=== Path Parameters
include::{snippets}/user/update_user/path-parameters.adoc[]

== Request password reset over email 
=== CURL sample
include::{snippets}/user/request_reset_password/curl-request.adoc[]

=== Path Parameters
include::{snippets}/user/request_reset_password/path-parameters.adoc[]

== Reset password using token obtained over email 
=== CURL sample
include::{snippets}/user/reset_password/curl-request.adoc[]

=== Request Parameters
include::{snippets}/user/reset_password/request-parameters.adoc[]