921 lines
36 KiB
PHP
921 lines
36 KiB
PHP
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
|
<title>Laravel API Documentation</title>
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans&display=swap" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.style.css") }}" media="screen">
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.print.css") }}" media="print">
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.10/lodash.min.js"></script>
|
|
|
|
<link rel="stylesheet"
|
|
href="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/styles/obsidian.min.css">
|
|
<script src="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/highlight.min.js"></script>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jets/0.14.1/jets.min.js"></script>
|
|
|
|
<style id="language-style">
|
|
/* starts out as display none and is replaced with js later */
|
|
body .content .bash-example code { display: none; }
|
|
body .content .javascript-example code { display: none; }
|
|
</style>
|
|
|
|
<script>
|
|
var tryItOutBaseUrl = "http://localhost";
|
|
var useCsrf = Boolean();
|
|
var csrfUrl = "/sanctum/csrf-cookie";
|
|
</script>
|
|
<script src="{{ asset("/vendor/scribe/js/tryitout-5.9.0.js") }}"></script>
|
|
|
|
<script src="{{ asset("/vendor/scribe/js/theme-default-5.9.0.js") }}"></script>
|
|
|
|
</head>
|
|
|
|
<body data-languages="["bash","javascript"]">
|
|
|
|
<a href="#" id="nav-button">
|
|
<span>
|
|
MENU
|
|
<img src="{{ asset("/vendor/scribe/images/navbar.png") }}" alt="navbar-image"/>
|
|
</span>
|
|
</a>
|
|
<div class="tocify-wrapper">
|
|
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
</div>
|
|
|
|
<div class="search">
|
|
<input type="text" class="search" id="input-search" placeholder="Search">
|
|
</div>
|
|
|
|
<div id="toc">
|
|
<ul id="tocify-header-introduction" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="introduction">
|
|
<a href="#introduction">Introduction</a>
|
|
</li>
|
|
</ul>
|
|
<ul id="tocify-header-authenticating-requests" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="authenticating-requests">
|
|
<a href="#authenticating-requests">Authenticating requests</a>
|
|
</li>
|
|
</ul>
|
|
<ul id="tocify-header-authentication" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="authentication">
|
|
<a href="#authentication">Authentication</a>
|
|
</li>
|
|
<ul id="tocify-subheader-authentication" class="tocify-subheader">
|
|
<li class="tocify-item level-2" data-unique="authentication-POSTapi-v1-auth-login">
|
|
<a href="#authentication-POSTapi-v1-auth-login">Login</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="authentication-POSTapi-v1-auth-logout">
|
|
<a href="#authentication-POSTapi-v1-auth-logout">Logout</a>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
<ul id="tocify-header-user-management" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="user-management">
|
|
<a href="#user-management">User Management</a>
|
|
</li>
|
|
<ul id="tocify-subheader-user-management" class="tocify-subheader">
|
|
<li class="tocify-item level-2" data-unique="user-management-POSTapi-v1-users">
|
|
<a href="#user-management-POSTapi-v1-users">Create User</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="user-management-PUTapi-v1-users--id-">
|
|
<a href="#user-management-PUTapi-v1-users--id-">Update User</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="user-management-DELETEapi-v1-users--id-">
|
|
<a href="#user-management-DELETEapi-v1-users--id-">Delete User</a>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
</div>
|
|
|
|
<ul class="toc-footer" id="toc-footer">
|
|
<li style="padding-bottom: 5px;"><a href="{{ route("scribe.postman") }}">View Postman collection</a></li>
|
|
<li style="padding-bottom: 5px;"><a href="{{ route("scribe.openapi") }}">View OpenAPI spec</a></li>
|
|
<li><a href="http://github.com/knuckleswtf/scribe">Documentation powered by Scribe ✍</a></li>
|
|
</ul>
|
|
|
|
<ul class="toc-footer" id="last-updated">
|
|
<li>Last updated: May 7, 2026</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="page-wrapper">
|
|
<div class="dark-box"></div>
|
|
<div class="content">
|
|
<h1 id="introduction">Introduction</h1>
|
|
<aside>
|
|
<strong>Base URL</strong>: <code>http://localhost</code>
|
|
</aside>
|
|
<pre><code>This documentation aims to provide all the information you need to work with our API.
|
|
|
|
<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
|
|
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside></code></pre>
|
|
|
|
<h1 id="authenticating-requests">Authenticating requests</h1>
|
|
<p>This API is not authenticated.</p>
|
|
|
|
<h1 id="authentication">Authentication</h1>
|
|
|
|
<p>APIs for managing authentication</p>
|
|
|
|
<h2 id="authentication-POSTapi-v1-auth-login">Login</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
<p>Authenticate a user and return a Sanctum token.</p>
|
|
|
|
<span id="example-requests-POSTapi-v1-auth-login">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost/api/v1/auth/login" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"email\": \"gbailey@example.net\",
|
|
\"password\": \"architecto\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/auth/login"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"email": "gbailey@example.net",
|
|
"password": "architecto"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-auth-login">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-auth-login" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-auth-login"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-auth-login"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-auth-login" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-auth-login">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-auth-login" data-method="POST"
|
|
data-path="api/v1/auth/login"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-auth-login', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-auth-login"
|
|
onclick="tryItOut('POSTapi-v1-auth-login');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-auth-login"
|
|
onclick="cancelTryOut('POSTapi-v1-auth-login');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-auth-login"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/auth/login</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-auth-login"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-auth-login"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-auth-login"
|
|
value="gbailey@example.net"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Example: <code>gbailey@example.net</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-auth-login"
|
|
value="architecto"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>architecto</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="authentication-POSTapi-v1-auth-logout">Logout</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
<p>Revoke the current user's token.</p>
|
|
|
|
<span id="example-requests-POSTapi-v1-auth-logout">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost/api/v1/auth/logout" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/auth/logout"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-auth-logout">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-auth-logout" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-auth-logout"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-auth-logout"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-auth-logout" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-auth-logout">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-auth-logout" data-method="POST"
|
|
data-path="api/v1/auth/logout"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-auth-logout', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-auth-logout"
|
|
onclick="tryItOut('POSTapi-v1-auth-logout');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-auth-logout"
|
|
onclick="cancelTryOut('POSTapi-v1-auth-logout');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-auth-logout"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/auth/logout</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-auth-logout"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-auth-logout"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h1 id="user-management">User Management</h1>
|
|
|
|
<p>APIs for managing users</p>
|
|
|
|
<h2 id="user-management-POSTapi-v1-users">Create User</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
<p>Create a new user with roles.</p>
|
|
|
|
<span id="example-requests-POSTapi-v1-users">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost/api/v1/users" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"firstName\": \"b\",
|
|
\"lastName\": \"n\",
|
|
\"email\": \"ashly64@example.com\",
|
|
\"password\": \"pBNvYg\",
|
|
\"status\": \"inactive\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/users"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"firstName": "b",
|
|
"lastName": "n",
|
|
"email": "ashly64@example.com",
|
|
"password": "pBNvYg",
|
|
"status": "inactive"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-users">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-users" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-users"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-users"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-users" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-users">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-users" data-method="POST"
|
|
data-path="api/v1/users"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-users', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-users"
|
|
onclick="tryItOut('POSTapi-v1-users');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-users"
|
|
onclick="cancelTryOut('POSTapi-v1-users');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-users"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/users</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-users"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-users"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>firstName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="firstName" data-endpoint="POSTapi-v1-users"
|
|
value="b"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>b</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>lastName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="lastName" data-endpoint="POSTapi-v1-users"
|
|
value="n"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>n</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-users"
|
|
value="ashly64@example.com"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Example: <code>ashly64@example.com</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-users"
|
|
value="pBNvYg"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 8 characters. Example: <code>pBNvYg</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="POSTapi-v1-users"
|
|
value="inactive"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>inactive</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>active</code></li> <li><code>inactive</code></li> <li><code>suspended</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>roles</code></b>
|
|
<small>object</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="roles" data-endpoint="POSTapi-v1-users"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="user-management-PUTapi-v1-users--id-">Update User</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
<p>Update a user's details.</p>
|
|
|
|
<span id="example-requests-PUTapi-v1-users--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost/api/v1/users/16" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"firstName\": \"b\",
|
|
\"lastName\": \"n\",
|
|
\"status\": \"inactive\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/users/16"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"firstName": "b",
|
|
"lastName": "n",
|
|
"status": "inactive"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-users--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-users--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-users--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-users--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-users--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-users--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-users--id-" data-method="PUT"
|
|
data-path="api/v1/users/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-users--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-users--id-"
|
|
onclick="tryItOut('PUTapi-v1-users--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-users--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-users--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-users--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/users/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/users/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-users--id-"
|
|
value="16"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the user. Example: <code>16</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>firstName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="firstName" data-endpoint="PUTapi-v1-users--id-"
|
|
value="b"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>b</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>lastName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="lastName" data-endpoint="PUTapi-v1-users--id-"
|
|
value="n"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>n</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="PUTapi-v1-users--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="PUTapi-v1-users--id-"
|
|
value="inactive"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>inactive</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>active</code></li> <li><code>inactive</code></li> <li><code>suspended</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="user-management-DELETEapi-v1-users--id-">Delete User</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
<p>Soft delete a user.</p>
|
|
|
|
<span id="example-requests-DELETEapi-v1-users--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost/api/v1/users/16" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost/api/v1/users/16"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-users--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-users--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-users--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-users--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-users--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-users--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-users--id-" data-method="DELETE"
|
|
data-path="api/v1/users/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-users--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-users--id-"
|
|
onclick="tryItOut('DELETEapi-v1-users--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-users--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-users--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-users--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/users/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-users--id-"
|
|
value="16"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the user. Example: <code>16</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="dark-box">
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|