diff options
Diffstat (limited to 'subsonic-site/src/main/webapp/api-createUser.jsp')
-rw-r--r-- | subsonic-site/src/main/webapp/api-createUser.jsp | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/subsonic-site/src/main/webapp/api-createUser.jsp b/subsonic-site/src/main/webapp/api-createUser.jsp new file mode 100644 index 00000000..331148b3 --- /dev/null +++ b/subsonic-site/src/main/webapp/api-createUser.jsp @@ -0,0 +1,112 @@ +<h2 class="div"><a name="createUser"></a>createUser</h2>
+
+<p>
+ <code>http://your-server/rest/createUser.view</code>
+ <br>Since <a href="#versions">1.1.0</a>
+</p>
+
+<p>
+ Creates a new Subsonic user, using the following parameters:
+</p>
+<table width="100%" class="bottomspace">
+ <tr>
+ <th class="param-heading">Parameter</th>
+ <th class="param-heading">Required</th>
+ <th class="param-heading">Default</th>
+ <th class="param-heading">Comment</th>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>username</code></td>
+ <td>Yes</td>
+ <td></td>
+ <td>The name of the new user.</td>
+ </tr>
+ <tr>
+ <td><code>password</code></td>
+ <td>Yes</td>
+ <td></td>
+ <td>The password of the new user, either in clear text of hex-encoded (see above).</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>email</code></td>
+ <td>Yes</td>
+ <td></td>
+ <td>The email address of the new user.</td>
+ </tr>
+ <tr>
+ <td><code>ldapAuthenticated</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is authenicated in LDAP.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>adminRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is administrator.</td>
+ </tr>
+ <tr>
+ <td><code>settingsRole</code></td>
+ <td>No</td>
+ <td>true</td>
+ <td>Whether the user is allowed to change settings and password.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>streamRole</code></td>
+ <td>No</td>
+ <td>true</td>
+ <td>Whether the user is allowed to play files.</td>
+ </tr>
+ <tr>
+ <td><code>jukeboxRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is allowed to play files in jukebox mode.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>downloadRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is allowed to download files.</td>
+ </tr>
+ <tr>
+ <td><code>uploadRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is allowed to upload files.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>playlistRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is allowed to create and delete playlists. Since 1.8.0, changing this role has no effect.</td>
+ </tr>
+ <tr>
+ <td><code>coverArtRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is allowed to change cover art and tags.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>commentRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is allowed to create and edit comments and ratings.</td>
+ </tr>
+ <tr>
+ <td><code>podcastRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>Whether the user is allowed to administrate Podcasts.</td>
+ </tr>
+ <tr class="table-altrow">
+ <td><code>shareRole</code></td>
+ <td>No</td>
+ <td>false</td>
+ <td>(Since <a href="#versions">1.8.0</a>)Whether the user is allowed to share files with anyone.</td>
+ </tr>
+</table>
+
+<p>
+ Returns an empty <code><subsonic-response></code> element on success.
+</p>
|