Managing Users
With Couchdrop you can configure additional users. Additional users cannot manage your Couchdrop service, but are able to upload/download and view files.
getGet Users
get
https://api.couchdrop.io/manage/credentials
This endpoint allows you to get configured users/credentials
Request
Response
Query Parameters
token
required
string
API Access Token
200: OK
Credentials successfully retrieved.
{"credentials": [{"id": "905abg1a-f206-11e8-b591-0242bc140002","password": "password","permissions_mode": "r","permissions_path": "/box/michael","public_key": null,"username": "michael"}]}
putAdd User
put
https://api.couchdrop.io/manage/credentials
Add a user
Request
Response
Path Parameters
token
required
string
API Access Token
200: OK
User was added
{id: "abc", username: "user-xyz"}
postModify a User
post
https://api.couchdrop.io/manage/credentials
This method is used to modify a user. Either the username or id can be supplied. If you wish to change the username, then the id must be specified.
Request
Response
Path Parameters
token
required
string
API Access Token
Body Parameters
id
required
string
User identifier, generated by system
permissions_path
optional
string
Root/Home directory
permissions_mode
optional
string
Permissions, IE: "rw"
public_key
optional
string
SSH Public Key
password
optional
string
Password
username
required
string
Username
200: OK
deleteDelete A User
delete
https://api.couchdrop.io/manage/credentials/:username/delete
Request
Response
Path Parameters
username
required
string
Username to delete
token
required
string
API Access Token
200: OK