user.adoc 3.48 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
= Rest API Documentation - Users
Piotr Gawron
v{project-version} {build-time}
:toc: left
:sectnums:

== List available formats
=== 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[]

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
== 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[]

47

48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
== 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[]

Piotr Gawron's avatar
Piotr Gawron committed
90
91
=== Request Fields
include::{snippets}/user/update_preferences_1/request-fields.adoc[]
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

=== 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[]

121
122
123
124
125
126
127
128
129
130
131
132
133
134
== 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[]