Skip to content

Commit 02f61ca

Browse files
committed
Added Authentication service logout action on documentation pages.
1 parent b9b76be commit 02f61ca

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

documentations/src/views/Authentication.vue

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
<h4 class="border-bottom">📡 Authentication API Calls</h4>
4545

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>
4747
<p>Create a new user on account list of specified QLBase application key and ID.</p>
4848
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_create_user</pre>
4949

@@ -62,7 +62,7 @@
6262
<span class="text-warning">"enabled"</span>: <span class="text-danger">"0|1"</span>
6363
<span class="text-primary">}</span></pre>
6464

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>
6666
<p>Update QLBase application account informations by username of user.</p>
6767
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_update_by_username</pre>
6868

@@ -81,7 +81,7 @@
8181
<span class="text-warning">"enabled"</span>: <span class="text-danger">"0|1"</span>
8282
<span class="text-primary">}</span></pre>
8383

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>
8585
<p>Update QLBase application account information by email of user.</p>
8686
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_update_by_email</pre>
8787

@@ -100,7 +100,7 @@
100100
<span class="text-warning">"enabled"</span>: <span class="text-danger">"0|1"</span>
101101
<span class="text-primary">}</span></pre>
102102

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>
104104
<p>Delete QLBase application account information by username of user.</p>
105105
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_delete_by_username</pre>
106106

@@ -113,7 +113,7 @@
113113
<span class="text-warning">"username"</span>: <span class="text-danger">"&lt;username&gt;"</span>
114114
<span class="text-primary">}</span></pre>
115115

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>
117117
<p>Delete QLBase application account information by email of user.</p>
118118
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_delete_by_email</pre>
119119

@@ -126,7 +126,7 @@
126126
<span class="text-warning">"email"</span>: <span class="text-danger">"&lt;email&gt;"</span>
127127
<span class="text-primary">}</span></pre>
128128

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>
130130
<p>Fetch QLBase application account informations specified by username of user.</p>
131131
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_get_by_username</pre>
132132

@@ -155,7 +155,7 @@
155155
<span class="text-primary">]</span>
156156
<span class="text-primary">}</span></pre>
157157

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>
159159
<p>Fetch QLBase application account informations specified by email of user.</p>
160160
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_get_by_email</pre>
161161

@@ -184,7 +184,7 @@
184184
<span class="text-primary">]</span>
185185
<span class="text-primary">}</span></pre>
186186

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>
188188
<p>Enable specified QLBase application user account.</p>
189189
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_enable_user</pre>
190190

@@ -197,7 +197,7 @@
197197
<span class="text-warning">"username"</span>: <span class="text-danger">"&lt;username&gt;"</span>
198198
<span class="text-primary">}</span></pre>
199199

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>
201201
<p>Disable specified QLBase application user account.</p>
202202
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_disable_user</pre>
203203

@@ -210,7 +210,7 @@
210210
<span class="text-warning">"username"</span>: <span class="text-danger">"&lt;username&gt;"</span>
211211
<span class="text-primary">}</span></pre>
212212

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>
214214
<p>Check if the specified QLBase application user account is either enabled or disabled.</p>
215215
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_is_enabled</pre>
216216

@@ -233,7 +233,7 @@
233233
<span class="text-warning">"value"</span>: <span class="text-danger">"&lt;enabled&gt;"</span>,
234234
<span class="text-primary">}</span></pre>
235235

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>
237237
<p>Log-in a specified QLBase application user account using username and an MD5-hashed password string.</p>
238238
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_login_username</pre>
239239

@@ -258,7 +258,7 @@
258258
<span class="text-warning">"value"</span>: <span class="text-danger">"&lt;logged_in&gt;"</span>
259259
<span class="text-primary">}</span></pre>
260260

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>
262262
<p>Log-in a specified QLBase application user account using email and an MD5-hashed password string.</p>
263263
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_login_email</pre>
264264

@@ -283,7 +283,20 @@
283283
<span class="text-warning">"value"</span>: <span class="text-danger">"&lt;logged_in&gt;"</span>
284284
<span class="text-primary">}</span></pre>
285285

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> &mdash; 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">"&lt;uuid&gt;"</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>
287300
<p>Fetch all the QLBase application user informations including username, email, enability, and timestamp of creation.</p>
288301
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=auth_fetch_all</pre>
289302

0 commit comments

Comments
 (0)