api/documentation/topics/generated/completeSubuserSetup.topic

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       title="Complete subuser setup" id="completeSubuserSetup">

    <!-- AUTO-GENERATED, DO NOT EDIT -->
    <p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
    <chapter title="Endpoint" id="endpoint">
        <code-block lang="http">POST /subusers/setup</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>completeSubuserSetup</code></p>
        <p>Completes subuser setup by setting a password and basic profile fields. Accepts optional
`username` and `email`.
</p>
    </chapter>
    <chapter title="Authentication" id="authentication"><p>No authentication required.</p></chapter>
    <chapter title="Request Body" id="request-body">
        <p>Required: yes.</p>
        <p>Content type: <code>application/json</code></p>
        <code-block lang="json">
{
  &quot;properties&quot;: {
    &quot;email&quot;: {
      &quot;format&quot;: &quot;email&quot;,
      &quot;maxLength&quot;: 255,
      &quot;minLength&quot;: 3,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;name&quot;: {
      &quot;maxLength&quot;: 255,
      &quot;minLength&quot;: 3,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;password&quot;: {
      &quot;description&quot;: &quot;Must include at least one uppercase letter, one lowercase letter, and one number&quot;,
      &quot;format&quot;: &quot;password&quot;,
      &quot;minLength&quot;: 8,
      &quot;pattern&quot;: &quot;^(?=.*[a-z])(?=.*[A-Z])(?=.*\\\\d).+$&quot;,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;token&quot;: {
      &quot;description&quot;: &quot;One-time setup token&quot;,
      &quot;type&quot;: &quot;string&quot;
    },
    &quot;username&quot;: {
      &quot;maxLength&quot;: 255,
      &quot;minLength&quot;: 3,
      &quot;type&quot;: &quot;string&quot;
    }
  },
  &quot;required&quot;: [
    &quot;token&quot;,
    &quot;password&quot;,
    &quot;name&quot;
  ],
  &quot;type&quot;: &quot;object&quot;
}
        </code-block>
    </chapter>
    <chapter title="Responses" id="responses">
        <table>
            <tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
            <tr><td>200</td><td>Setup completed</td><td>application/json</td></tr>
            <tr><td>400</td><td></td><td></td></tr>
            <tr><td>500</td><td></td><td></td></tr>
        </table>
        <p>Schema for response <code>200</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;properties&quot;: {
    &quot;message&quot;: {
      &quot;example&quot;: &quot;Password set successfully&quot;,
      &quot;type&quot;: &quot;string&quot;
    }
  },
  &quot;type&quot;: &quot;object&quot;
}
        </code-block>
    </chapter>
</topic>