Sign in
Drive > Users

Create user

Create a new user resource

post/2/drive/{drive_id}/users

Path parameters

drive_idinteger required

Drive identifier

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

Request body

emailsstring[]
file_idinteger nullable

For adding a file shared along the invitation.

lang'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pt' nullable

Invitation language fallback if user's preference is not found

messagestring nullable
namestring nullable

Name of the resource {name}

right'manage' | 'none' | 'read' | 'write' nullable

Access level of {name}.<note><strong>manage</strong>: Can share, write and read the file.</note><note><strong>none</strong>: Can not act on the file.</note><note><strong>read</strong>: Can only read the file.</note><note><strong>write</strong>: Can write and read the file.</note>

role'admin' | 'external' | 'user' required

Administration level of the user.<note><strong>admin</strong>: Administrator of the drive, can manage the drive (settings, invitations and users) and the files.</note><note><strong>external</strong>: External user can only access the files given by the others roles.</note><note><strong>user</strong>: Internal user can invite user and manage the files of his private directory and other directories with manage file access.</note>

send_emailboolean
team_idsinteger[]
type'main' | 'shared'

Type of the access; this field is no longer used and has been replaced by an additional role property external.<note><strong>main</strong>: User has access to the drive.</note><note><strong>shared</strong>: User has access to a shared file / directory only.</note>

user_idsinteger[]

Example request

{
  "right": "manage",
  "role": "admin",
  "type": "main"
}

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

data91ac10ffCreateDriveUserResponse[] — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.