A User is anybody using this service. Users may be admins, managers, photographers, IT, etc.

A Group is a group of Users and/or other Groups.

Group Memberships hold the relationship between a Group and its "members". User Resources and/or Group Resources can be members of any Group.

Contacts are the Users and Groups that a User can choose from in auto-complete lists. For example, when a user types the letter "S", the Contacts "Sally", "Sales Engineers", and "Mike Stevens" would be possible suggestions.

Properties

  • created_at - (read-only)
  • deactivated - (read-only except for admins) boolean
  • default_workspace_choice - "selected" or "last_used"
  • default_workspace_id - The ID of the Workspace that should open by default when opening a new client. Clients are responsible for setting and changing this.
  • email - (required)
  • email_verified - (read-only) boolean
  • first_name - (optional)
  • home_file_id - (read-only) The file id of the user&39;s home folder in the user&39;s default workspace.
  • home_node_id - (read-only) The ID of the node containing the user&39;s home folder in the user&39;s default workspace.
  • id - (read-only)
  • last_name - (optional)
  • name - (read-only) The name that should be displayed for the user
  • needs_password - (read-only) boolean
  • organization_admin - (read-only except for admins) boolean
  • organization_id - (read-only)
  • password - (write-only)
  • running_operation_count - (read-only)
  • stopped_operation_count - (read-only)
  • updated_at - (read-only)

Query Parameters (for GET):

  • created_at
  • deactivated - true/false
  • email
  • embed%5B%5D=default_workspace
  • embed%5B%5D=home_node
  • embed%5B%5D=organization
  • first_name
  • last_login_at
  • last_name
  • name
  • organization_admin - true/false
  • updated_at

GET and PUT

This is an alias to /users/{current user id}.

GET and POST

This collection resource contains all the users that the logged in user can access.

Examples

POST /users
{
  "email": "u@example.com"
}
201 Created
{
  "id": "1",
  "email": "u@example.com",
  "needs_password": true,
  "email_verified": false,
  "home_node_id": "3",
  "home_file_id": "Z5",
  "saml_configuration_id": null
}

Each user is identified by email address, so "email" is a required property when creating a new user.

GET, PUT, and DELETE

Examples

GET /users/1
200 Ok
{
  "id": 1,
  "email": "u@example.com",
  "email_verified": false,
  "organization_id": "1",
  "home_node_id": "3",
  "home_file_id": "Z5",
  "saml_configuration_id": null
}

These preferences indicate whether the user wants to receive emails and in-app notifications regarding various events. The preferences that end in _message control the in-app notifications, and the preferences that end in _email control the notifications sent to the user&39;s email.

For these preferences, a null value uses the server&39;s default.

Properties

  • added_to_dropbox_email - (boolean)
  • added_to_dropbox_message - (boolean)
  • added_to_group_email - (boolean)
  • added_to_group_message - (boolean)
  • added_to_workspace_email - (boolean)
  • added_to_workspace_message - (boolean)
  • file_shared_email - (boolean)
  • file_shared_message - (boolean)
  • invitation_to_send_to_dropbox_email - (boolean)
  • invitation_to_send_to_dropbox_message - (boolean)
  • invitation_to_send_to_individual_email - (boolean)
  • invitation_to_send_to_individual_message - (boolean)
  • package_contents_deleted_email - (boolean)
  • package_expired_email - (boolean)
  • package_received_email - (boolean)
  • package_received_message - (boolean)

The preferences that end in _message control the in-app notifications, and the preferences that end in _email control the notifications sent to the user&39;s email.

For these preferences, a null value uses the server&39;s default.

GET and PUT

Properties

  • created_at - (read-only)
  • description - (optional)
  • id - (read-only)
  • name - (required)
  • running_operation_count - (read-only)
  • saml_group - (boolean) - Mark this group as a SAML group (optional, default false)
  • saml_group_dn - (string) - The DN to map this group to the SAML IDP&39;s group (optional)
  • stopped_operation_count - (read-only)
  • system_group - (read-only, boolean)
  • system_group_type - one of dropbox_members, dropbox_senders, dropbox_recipients, saml_users, workspace_members, workspace_managers
  • updated_at - (read-only)

Query Parameters (for GET):

  • created_at
  • manager=true - only return direct groups that the user manages/owns
  • name
  • q - Search name
  • system_group - (true/false, defaults to true) whether to include internal system groups in the results
  • updated_at

GET and POST

Examples

POST /groups
{
  "name": "Animators"
}
201 Created
{
  "id": "5C",
  "name": "Animators",
  "saml_group": false,
  "saml_group_dn": null
}

GET, PUT, and DELETE

Examples

GET /groups/5C
200 Ok
{
  "id": "5C",
  "name": "Animators",
  "saml_group": false,
  "saml_group_dn": null
}

Properties

  • id - (read-only)
  • group_id - (required)
  • member_type - (required)
  • member_id - (required)
  • running_operation_count - (read-only)
  • stopped_operation_count - (read-only)

Query Parameters (for GET):

  • group.system_group - true/false
  • group_id
  • member_type - user/group
  • member_id
  • system_group - true/false
  • embed%5B%5D=group
  • embed%5B%5D=member
  • q - search
    • q=jacob will search members for "jacob"
    • q=last_login_at:>2015-01-01 (URI escaped: q=last_login_at%3A%3E2015-01-01) will search for all member users who have logged in since January 1st, 2015.

Sort keys:

  • member.name - user/group name
  • member.first_name
  • member.last_name
  • member.email
  • member.system_group
  • member.last_login_at

NOTE - You cannot add or remove group memberships for SAML groups

This resource lets you

  • list a User&39;s Groups,
  • list all of the Groups that a specific Group is a member of ("parent Groups"),
  • list a Group&39;s "children" (Users and Groups that are members of that Group),
  • add/remove a User to/from a Group,
  • add/remove a Group to/from another Group,

Examples

List all of the Groups that a specific Group is a member of ("parent Groups").

GET /group_memberships?embed%5B%5D=group&member_type=group&member_id=5C
200 Ok
[
  {
    "id": "2",
    "group_id": "7C",
    "member_type": "group",
    "member_id": "5C",
    "group": {
      "name": "Animators"
    }
  },
  {
    "id": "W",
    "group_id": "00",
    "member_type": "group",
    "member_id": "5C",
    "group": {
      "name": "All"
    }
  }
]

List a Group&39;s "children".

GET /group_memberships?embed%5B%5D=member&group_id=5C
200 Ok
[
  {
    "id": "1",
    "group_id": "5C",
    "member_type": "group",
    "member_id": "2x",
    "member": {
      "id": "2x",
      "name": "Emeryville Animators"
    }
  },
  {
    "id": "2",
    "group_id": "5C",
    "member_type": "group",
    "member_id": "O3",
    "member": {
      "id": "O3",
      "name": "Beijing Animators"
    }
  },
  {
    "id": "3",
    "group_id": "5C",
    "member_type": "user",
    "member_id": "sSeF1",
    "member": {
      "id": "sSeF1",
      "name": "Timothy Mark Hamilton O'Brian III",
      "email": "timothy@example.com"
    }
  }
]

Add a User to a Group

POST /group_memberships
{
  "group_id": "5C",
  "member_type": "user",
  "member_id": "fa23fx"
}
200 Ok
{
  "id": "342X",
  "group_id": "5C",
  "member_type": "user",
  "member_id": "fa23fx"
}

Properties

  • addressee_email - (required when addressee_type is email)
  • addressee_id - (required when addressee_type is user or group)
  • addressee_type - (required)
  • body - (optional) the message body that will be included in the invitation email.
  • created_at - (read-only)
  • file_id - (required when type is file_shared)
  • file_name - (required when type is file_shared)
  • file_type - (required when type is file_shared) file/folder
  • id - (read-only)
  • message - (optional)
  • node_id - (required when type is file_shared)
  • type - (required) dropbox/send_to_me/file_shared
  • url_token_id - (required) The ID of the URL token that should be sent in the invitation email.
  • user_id - (required)
  • workspace_id - (required)

Same as /invitations with user_id automatically set.

POST only


Direct access to on-site storage

On-site storage that is hooked up to a company's Directory Server (DS) can use an email address to set OS-level permissions on files by looking up the user by email address in their DS. This enables users to use CIFS shares and NFS mounts to securely access files and folders created using this API.

Video player

Video

×

Reset your Password Password resets are handled on the Support Site

×