This endpoint allows you to query or modify dropbox and workgroup memberships. (Either "dropbox" or "workgroup" is included in the call to the endpoint.)

Create (POST), edit (PUT), and delete (DELETE) requests are only available to admin users; this access is mediated by the requesting user's admin status: for example, Faspex admins have full access, workgroup admins can see all users in the workgroup and may or may not have permission to modify memberships.

Non-admin users may or may not be able to view (GET) information for other users, depending on their permissions.

Note: In each endpoint method described below, workgroup|dropbox indicates that you can enter either workgroup or dropbox in the request.

Request Parameters (Dropbox)

Parameter Name Type Description
e_dropbox_id string Dropbox ID
dbox_extusr_expired boolean External user for the dropbox has expired (true/false)
dbox_extusr_expires_at ISO date format Date and time that external user expires
dbox_extusr_passcode string Passcode for external user of a dropbox
dbox_extusr_single_use string Single-use password for external user of a dropbox

Request Parameters (Workgroup)

Parameter Name Type Description
e_workgroup_id string Workgroup ID

Request Parameters (Both Dropbox and Workgroup)

Parameter Name Type Description
user_id string User ID corresponding to the dropbox or workgroup.
Note: This only be modified with a create (POST) request.
e_workgroup_id string Workgroup ID
Note: This only be modified with a create (POST) request.
can_read boolean User has read permission for a dropbox or workgroup (true/false)
can_write boolean User has write permission for a dropbox or workgroup (true/false)
is_wg_admin boolean User is an admin for a workgroup (true/false)
id string Membership ID (read-only)
created_at ISO date format Date and time when dropbox or workgroup created (read-only)
invited_at ISO date format Date and time when user invited to dropbox or workgroup (read-only)
updated_at ISO date format Date and time when dropbox or workgroup updated (read-only)

Common Error Codes

  • 404 No Content - Package not found; returns an error object
  • 400 Bad Request - Request parameters are invalid; returns an error object
  • 500 Internal Server Error - Request is valid but the server encountered an error; returns an error object

Get current current workgroup or dropbox memberships

GET /api/dropbox|workgroup_memberships

This method returns a list of current dropbox memberships or workgroup memberships.

Query Parameters (Optional)

You may filter your request by user or a by specific dropbox or workgroup (user_id, e_dropbox_id or e_workgroup_id). If you don't user filtering parameters, the request returns all workgroup memberships or dropbox memberships for all users.

Request Body: None

Success Response Code

  • 200 OK - Returned with an array of dropbox and workgroup memberships

Get a dropbox or workgroup membership

GET /api/dropbox|workgroup_memberships/:id

This method returns membership information for a specific dropbox or workgroup.

Request Body: None

Success Response Code

  • 200 OK - Returned with membership information for the dropbox membership or workgroup membership

Create a dropbox or workgroup

POST /api/dropbox|workgroup_memberships

This method creates a new dropbox membership or workgroup membership.

Request Body: Include the dropbox or workgroup parameters you need (user_id and e_workgroup_id are required).

Example:

{
"workgroup_membership":
     {
     "user_id": 3,
     "e_workgroup_id": 6
     }
}

Success Response Code

  • 201 Created - Returned with information about the newly created dropbox membership or workgroup membership

Update a dropbox membership or workgroup membership

PUT /api/dropbox|workgroup_memberships/:id

This method updates the specified dropbox membership or workgroup membership.

Request Body: Includes the dropbox membership or workgroup membership you need to update

Success Response Code

  • 200 OK - Returned with the updated dropbox membership or workgroup membership information

Delete a dropbox membership or workgroup membership

DELETE /api/(dropbox|workgroup)_memberships/:id

This method deletes the specified dropbox or workgroup.

Request Body: None

Success Response Code

  • 204 No Content - Returned without a response body

Request and Response Examples

Request: Create a dropbox membership

POST /api/admin/dropbox_memberships

Example Request Body:

{
"workgroup_membership":
     {
     "user_id": 3,
     "e_workgroup_id": 6
     }
}

Response Example:

201 CREATED
{
  "id":1,
  "e_workgroup_id":1,
  "e_workgroup_type":"Workgroup",
  "e_workgroup_name":"New Workgroup",
  "user_id":1,
  "can_read":true,
  "can_write":true,
  "is_wg_admin":false,
  "created_at":"2016/07/11 16:30:13 -0700",
  "updated_at":"2016/07/11 16:30:13 -0700"
}
Video player

Video

×