|
43 | 43 |
|
44 | 44 | <h4 class="border-bottom">📡 Authentication API Calls</h4>
|
45 | 45 |
|
46 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth New User</b> |
| 46 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: New User</b> |
47 | 47 | <p>Create a new user on account list of specified QLBase application key and ID.</p>
|
48 | 48 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_create_user</pre>
|
49 | 49 |
|
|
62 | 62 | <span class="text-warning">"enabled"</span>: <span class="text-danger">"0|1"</span>
|
63 | 63 | <span class="text-primary">}</span></pre>
|
64 | 64 |
|
65 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Update by Username</b> |
| 65 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Update by Username</b> |
66 | 66 | <p>Update QLBase application account informations by username of user.</p>
|
67 | 67 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_update_by_username</pre>
|
68 | 68 |
|
|
81 | 81 | <span class="text-warning">"enabled"</span>: <span class="text-danger">"0|1"</span>
|
82 | 82 | <span class="text-primary">}</span></pre>
|
83 | 83 |
|
84 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Update by Email</b> |
| 84 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Update by Email</b> |
85 | 85 | <p>Update QLBase application account information by email of user.</p>
|
86 | 86 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_update_by_email</pre>
|
87 | 87 |
|
|
100 | 100 | <span class="text-warning">"enabled"</span>: <span class="text-danger">"0|1"</span>
|
101 | 101 | <span class="text-primary">}</span></pre>
|
102 | 102 |
|
103 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Delete by Username</b> |
| 103 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Delete by Username</b> |
104 | 104 | <p>Delete QLBase application account information by username of user.</p>
|
105 | 105 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_delete_by_username</pre>
|
106 | 106 |
|
|
113 | 113 | <span class="text-warning">"username"</span>: <span class="text-danger">"<username>"</span>
|
114 | 114 | <span class="text-primary">}</span></pre>
|
115 | 115 |
|
116 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Delete by Email</b> |
| 116 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Delete by Email</b> |
117 | 117 | <p>Delete QLBase application account information by email of user.</p>
|
118 | 118 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_delete_by_email</pre>
|
119 | 119 |
|
|
126 | 126 | <span class="text-warning">"email"</span>: <span class="text-danger">"<email>"</span>
|
127 | 127 | <span class="text-primary">}</span></pre>
|
128 | 128 |
|
129 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Get by Username</b> |
| 129 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Get by Username</b> |
130 | 130 | <p>Fetch QLBase application account informations specified by username of user.</p>
|
131 | 131 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_get_by_username</pre>
|
132 | 132 |
|
|
155 | 155 | <span class="text-primary">]</span>
|
156 | 156 | <span class="text-primary">}</span></pre>
|
157 | 157 |
|
158 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Get by Email</b> |
| 158 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Get by Email</b> |
159 | 159 | <p>Fetch QLBase application account informations specified by email of user.</p>
|
160 | 160 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_get_by_email</pre>
|
161 | 161 |
|
|
184 | 184 | <span class="text-primary">]</span>
|
185 | 185 | <span class="text-primary">}</span></pre>
|
186 | 186 |
|
187 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Enable User</b> |
| 187 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Enable User</b> |
188 | 188 | <p>Enable specified QLBase application user account.</p>
|
189 | 189 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_enable_user</pre>
|
190 | 190 |
|
|
197 | 197 | <span class="text-warning">"username"</span>: <span class="text-danger">"<username>"</span>
|
198 | 198 | <span class="text-primary">}</span></pre>
|
199 | 199 |
|
200 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Disable User</b> |
| 200 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Disable User</b> |
201 | 201 | <p>Disable specified QLBase application user account.</p>
|
202 | 202 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_disable_user</pre>
|
203 | 203 |
|
|
210 | 210 | <span class="text-warning">"username"</span>: <span class="text-danger">"<username>"</span>
|
211 | 211 | <span class="text-primary">}</span></pre>
|
212 | 212 |
|
213 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Is User Enabled</b> |
| 213 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Is User Enabled</b> |
214 | 214 | <p>Check if the specified QLBase application user account is either enabled or disabled.</p>
|
215 | 215 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_is_enabled</pre>
|
216 | 216 |
|
|
233 | 233 | <span class="text-warning">"value"</span>: <span class="text-danger">"<enabled>"</span>,
|
234 | 234 | <span class="text-primary">}</span></pre>
|
235 | 235 |
|
236 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Login Username</b> |
| 236 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Login Username</b> |
237 | 237 | <p>Log-in a specified QLBase application user account using username and an MD5-hashed password string.</p>
|
238 | 238 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_login_username</pre>
|
239 | 239 |
|
|
258 | 258 | <span class="text-warning">"value"</span>: <span class="text-danger">"<logged_in>"</span>
|
259 | 259 | <span class="text-primary">}</span></pre>
|
260 | 260 |
|
261 |
| - <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Login Email</b> |
| 261 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Login Email</b> |
262 | 262 | <p>Log-in a specified QLBase application user account using email and an MD5-hashed password string.</p>
|
263 | 263 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_login_email</pre>
|
264 | 264 |
|
|
283 | 283 | <span class="text-warning">"value"</span>: <span class="text-danger">"<logged_in>"</span>
|
284 | 284 | <span class="text-primary">}</span></pre>
|
285 | 285 |
|
286 |
| -<b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth Fetch All Users</b> |
| 286 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Logout</b> |
| 287 | + <p>Revoke the validity of the session ID (in UUID form) to logout the authenticated account.</p> |
| 288 | + <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_logout</pre> |
| 289 | + |
| 290 | + <b>Payload Structure</b> |
| 291 | + <ul> |
| 292 | + <li><i>uuid</i> — The session ID (in UUID form) to be revoked.</li> |
| 293 | + </ul> |
| 294 | + |
| 295 | + <pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span> |
| 296 | + <span class="text-warning">"sess_id"</span>: <span class="text-danger">"<uuid>"</span> |
| 297 | +<span class="text-primary">}</span></pre> |
| 298 | + |
| 299 | + <b class="mt-4 mb-2 d-block border-bottom fw-bold">Auth: Fetch All Users</b> |
287 | 300 | <p>Fetch all the QLBase application user informations including username, email, enability, and timestamp of creation.</p>
|
288 | 301 | <pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_fetch_all</pre>
|
289 | 302 |
|
|
0 commit comments