Files
api/documentation/_site_rebuild_20260317/subuserpasswordauth.html
T

128 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2026-03-17T15:45:48.150000672"><title>Authenticate subuser with password | Copenhagen Truck Wash API</title><script type="application/json" id="virtual-toc-data">[{"id":"endpoint","level":0,"title":"Endpoint","anchor":"#endpoint"},{"id":"operation","level":0,"title":"Operation","anchor":"#operation"},{"id":"authentication","level":0,"title":"Authentication","anchor":"#authentication"},{"id":"request-body","level":0,"title":"Request Body","anchor":"#request-body"},{"id":"responses","level":0,"title":"Responses","anchor":"#responses"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Authenticate subuser with password | Copenhagen Truck Wash API"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Copenhagen Truck Wash API Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/subuserpasswordauth.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Authenticate subuser with password | Copenhagen Truck Wash API"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
"@context": "http://schema.org",
"@type": "WebPage",
"@id": "writerside-documentation/subuserpasswordauth.html#webpage",
"url": "writerside-documentation/subuserpasswordauth.html",
"name": "Authenticate subuser with password | Copenhagen Truck Wash API",
"description": "",
"image": "",
"inLanguage":"en-US"
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
"@type": "WebSite",
"@id": "writerside-documentation/#website",
"url": "writerside-documentation/",
"name": "Copenhagen Truck Wash API Help"
}</script><!-- End Schema.org --></head><body data-id="subuserPasswordAuth" data-main-title="Authenticate subuser with password" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="API-Reference.topic|API Reference///Tag_Subusers.topic|Subusers///Tag_Subusers_Page_1.topic|Subusers - Page 1 of 1"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Copenhagen Truck Wash API Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="subuserPasswordAuth" id="subuserPasswordAuth.topic">Authenticate subuser with password</h1><p id="ar02uo_2">This endpoint documentation is generated directly from <code class="code" id="ar02uo_8">openapi.yaml</code>.</p><section class="chapter"><h2 id="endpoint" data-toc="endpoint">Endpoint</h2><div class="code-block" data-lang="http">POST /subusers/auth/password</div></section><section class="chapter"><h2 id="operation" data-toc="operation">Operation</h2><p id="ar02uo_10">Operation ID: <code class="code" id="ar02uo_12">subuserPasswordAuth</code></p><p id="ar02uo_11">Authenticates a subuser (driver) using a password together with one of the supported identifiers: `phone_country_code` + `phone`, `subuser_id`, or `username`. On success, returns a newly generated session token for the subuser.</p></section><section class="chapter"><h2 id="authentication" data-toc="authentication">Authentication</h2><p id="ar02uo_13">No authentication required.</p></section><section class="chapter"><h2 id="request-body" data-toc="request-body">Request Body</h2><p id="ar02uo_14">Required: yes.</p><p id="ar02uo_15">Content type: <code class="code" id="ar02uo_17">application/json</code></p><div class="code-block" data-lang="json">
{
&quot;oneOf&quot;: [
{
&quot;properties&quot;: {
&quot;password&quot;: {
&quot;format&quot;: &quot;password&quot;,
&quot;maxLength&quot;: 255,
&quot;minLength&quot;: 8,
&quot;type&quot;: &quot;string&quot;
},
&quot;phone&quot;: {
&quot;description&quot;: &quot;Phone number (415 digits, no leading +)&quot;,
&quot;example&quot;: 12345678,
&quot;maximum&quot;: 999999999999999,
&quot;minimum&quot;: 1000,
&quot;type&quot;: &quot;integer&quot;
},
&quot;phone_country_code&quot;: {
&quot;description&quot;: &quot;Phone country code (13 digits)&quot;,
&quot;example&quot;: 45,
&quot;maximum&quot;: 999,
&quot;minimum&quot;: 1,
&quot;type&quot;: &quot;integer&quot;
}
},
&quot;required&quot;: [
&quot;phone_country_code&quot;,
&quot;phone&quot;,
&quot;password&quot;
],
&quot;type&quot;: &quot;object&quot;
},
{
&quot;properties&quot;: {
&quot;password&quot;: {
&quot;format&quot;: &quot;password&quot;,
&quot;maxLength&quot;: 255,
&quot;minLength&quot;: 8,
&quot;type&quot;: &quot;string&quot;
},
&quot;subuser_id&quot;: {
&quot;description&quot;: &quot;Subuser ID&quot;,
&quot;example&quot;: 42,
&quot;type&quot;: &quot;integer&quot;
}
},
&quot;required&quot;: [
&quot;subuser_id&quot;,
&quot;password&quot;
],
&quot;type&quot;: &quot;object&quot;
},
{
&quot;properties&quot;: {
&quot;password&quot;: {
&quot;format&quot;: &quot;password&quot;,
&quot;maxLength&quot;: 255,
&quot;minLength&quot;: 8,
&quot;type&quot;: &quot;string&quot;
},
&quot;username&quot;: {
&quot;example&quot;: &quot;jdoe&quot;,
&quot;maxLength&quot;: 255,
&quot;minLength&quot;: 3,
&quot;type&quot;: &quot;string&quot;
}
},
&quot;required&quot;: [
&quot;username&quot;,
&quot;password&quot;
],
&quot;type&quot;: &quot;object&quot;
}
]
}
</div></section><section class="chapter"><h2 id="responses" data-toc="responses">Responses</h2><div class="table-wrapper"><table class="wide" id="ar02uo_18"><thead><tr class="ijRowHead" id="ar02uo_21"><th id="ar02uo_26"><p>Status</p></th><th id="ar02uo_27"><p>Description</p></th><th id="ar02uo_28"><p>Content Types</p></th></tr></thead><tbody><tr id="ar02uo_22"><td id="ar02uo_29"><p>200</p></td><td id="ar02uo_30"><p>Authentication successful</p></td><td id="ar02uo_31"><p>application/json</p></td></tr><tr id="ar02uo_23"><td id="ar02uo_32"><p>400</p></td><td id="ar02uo_33"></td><td id="ar02uo_34"></td></tr><tr id="ar02uo_24"><td id="ar02uo_35"><p>404</p></td><td id="ar02uo_36"></td><td id="ar02uo_37"></td></tr><tr id="ar02uo_25"><td id="ar02uo_38"><p>500</p></td><td id="ar02uo_39"></td><td id="ar02uo_40"></td></tr></tbody></table></div><p id="ar02uo_19">Schema for response <code class="code" id="ar02uo_41">200</code> (<code class="code" id="ar02uo_42">application/json</code>):</p><div class="code-block" data-lang="json">
{
&quot;oneOf&quot;: [
{
&quot;properties&quot;: {
&quot;session&quot;: {
&quot;description&quot;: &quot;Newly generated subuser session token&quot;,
&quot;example&quot;: &quot;2f7a8c0e-9b1d-4c6a-91a9-1a2b3c4d5e6f&quot;,
&quot;type&quot;: &quot;string&quot;
}
},
&quot;required&quot;: [
&quot;session&quot;
],
&quot;type&quot;: &quot;object&quot;
},
{
&quot;properties&quot;: {
&quot;2fa_required&quot;: {
&quot;example&quot;: true,
&quot;type&quot;: &quot;boolean&quot;
},
&quot;2fa_token&quot;: {
&quot;description&quot;: &quot;Temporary 2FA verification token&quot;,
&quot;example&quot;: &quot;557a3e7b1a2b...&quot;,
&quot;type&quot;: &quot;string&quot;
}
},
&quot;required&quot;: [
&quot;2fa_required&quot;,
&quot;2fa_token&quot;
],
&quot;type&quot;: &quot;object&quot;
}
]
}
</div></section><div class="last-modified">17 March 2026</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="listsubusers.html" class="navigation-links__prev">List subusers visible to the authenticated user</a><a href="listsubusergrants.html" class="navigation-links__next">List subuser grants</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.js"></script></body></html>