Groups
Managing groups can be done via the API. The following routes are available.
Get all groups
GET
https://api.couchdrop.io/manage/groups
Get all user groups in an organisation
Headers
Name | Type | Description |
---|---|---|
token* | String | API Token |
Get an individual group by ID
GET
https://api.couchdrop.io/manage/group/<group_id>
Headers
Name | Type | Description |
---|---|---|
token* | String | API Token |
Create an group
PUT
https://api.couchdrop.io/manage/groups
Create a new group
Headers
Name | Type | Description |
---|---|---|
token* | String | API Token |
Request Body
Name | Type | Description |
---|---|---|
groupname | String | Group Name |
Update an existing group
POST
https://api.couchdrop.io/manage/groups
Headers
Name | Type | Description |
---|---|---|
token* | String | API Token |
Request Body
Name | Type | Description |
---|---|---|
id* | String | Group ID |
groupname | String | Group name |
allowed_ips | String | Allowed IP addresses |
allow_sftp_scp_rsync | String | Allow SFTP based access |
allow_upload_portal | String | Allow access to the upload portal |
allow_ftp | String | Allow FTP based access |
allow_admin | String | Allow admin access |
allow_webportal | String | Allow access to the web portal |
allow_inboxes | String | Allow access to inboxs |
allow_shared_links | String | Allow access to shared links |
allow_workflows | String | Allow access to workflows |
Delete a group by ID
DELETE
https://api.couchdrop.io/manage/groups/<group_id>
Headers
Name | Type | Description |
---|---|---|
token* | String | API Token |
Get all group members
GET
https://api.couchdrop.io/manage/groups/<group_id>/users
Headers
Name | Type | Description |
---|---|---|
token* | String | API Token |
Last updated