Tuyu Developers

Developers

Customize the URLs on this site with your Tuyu URL:

https:// .
Method Documentation > Users and Workspaces

User Add POST

Description

Create a site user.

URL

All responses are in JSON format by default, to specify an XML response add “.xml” to the end of the method name (in this case “user_add”)

https://<your subdomain>.<your domain>/api/user_add

Restrictions

The calling user must have:

  • Admin privileges for the site.

Parameters

Bold indicates required.

Parameter Description
api_key Your API Key.
first_name The first name of the user being created.
last_name The last name of the user being created.
email The e-mail address of the user being created.
user_name The username of the user being created. This username must not be used by any other user on the site. Letters, numbers, hyphens, underscores, periods, or “@” only
password Explicitly set the password for the user being created. The password must adhere to this site's password security guidelines. Omit this parameter to have a temporary password automatically set for the user. NOTE: By entering a password a new user notification containing the user's login information will not be sent, and the user will not be asked to change their password upon logging in. It is entirely your responsibility to securely notify the user of their password, FileGenius takes no responsibility for compromised accounts if this parameter is used.
organization The organization of the user being created.
phone The phone number of the user being created, numbers only (e.g. 5015555555).
phone_ext The phone extension of the user being created, (numbers only).
active Default is “1”. “1” activates and sends a notification e-mail to the user containing their login credentials, “0” will create the user without sending a notification or allowing them to log-in.
admin Default is “0”. “1” creates the user as an admin which is granted all permissions, can go into any workspace, and can manage site settings. “0” will create the user as a regular user who must be joined to at least one workspace and must have at least one permission set to “1”.
batch_upload_files Default is “0”. “1” allows the user to upload and expand ZIP archives. Users with “admin” set to “1” will ignore this parameter.
upload_files Default is “0”. “1” allows the user to upload files. Users with “admin” set to “1” will ignore this parameter. Users with “batch_upload_files” set to “1” will automatically have this parameter set to “1”.
batch_download_files Default is “0”. “1” allows the user to download multiple files at once. Users with “admin” set to “1” will ignore this parameter.
download_files Default is “0”. “1” allows the user to download files. Users with “admin” set to “1” will ignore this parameter. Users with “batch_download_files” set to “1” will automatically have this parameter set to “1”.
batch_delete_files Default is “0”. “1” allows the user to delete multiple files at once. Users with “admin” set to “1” will ignore this parameter.
delete_files Default is “0”. “1” allows the user to delete files. Users with “admin” set to “1” will ignore this parameter. Users with “batch_delete_files” set to “1” will automatically have this parameter set to “1”.
send_files_non_user Default is “0”. “1” allows the user to send files to e-mail addresses without an account on the site. Users with “admin” set to “1” will ignore this parameter.
send_files Default is “0”. “1” allows the user to send files. Users with “admin” set to “1” will ignore this parameter. Users with “send_files_non_user” set to “1” will automatically have this parameter set to “1”.
batch_move_copy_files Default is “0”. “1” allows the user to move or copy multiple files at once. Users with “admin” set to “1” will ignore this parameter.
move_copy_files Default is “0”. “1” allows the user to move or copy files. Users with “admin” set to “1” will ignore this parameter. Users with “move_copy_files” set to “1” will automatically have this parameter set to “1”.
create_folders Default is “0”. “1” allows the user to create folders. Users with “admin” set to “1” will ignore this parameter.
rename_files Default is “0”. “1” allows the user to rename files. Users with “admin” set to “1” will ignore this parameter.
reset_password Default is “0”. “1” allows the user to request a password reset. Users with “admin” set to “1” will ignore this parameter.
upload_notifications Default is “0”. “1” allows the user to automatically receive a notification when an upload occurs in one of the user's workspaces. Users with “admin” set to “1” will ignore this parameter.
download_notifications Default is “0”. “1” allows the user to automatically receive a notification when an download occurs in one of the user's workspaces. Users with “admin” set to “1” will ignore this parameter.
user_workspaces A comma-separated list of workspace IDs the newly-created user will join. This is required if “admin” set to “0”
all_future_workspaces Default is “0”. “1” allows the user to be automatically joined to any workspace created in the future. Users with “admin” set to “1” will ignore this parameter.
create_workspace_from_name Default is “0”. “1” will create and join the user to a new workspace based on the user's first and last name. Users with “admin” set to “1” will ignore this parameter.
custom_notification_message Default is empty. If “active” is set to “1”, a custom message can be sent within the new user notification that contains the user's login credentials.
timestamp The current time in Unix timestamp format.
signature Please see “User Authentication” for more information.

Sample Response

Successful response In JSON:

{"userAdd":{"userId":1}}

Successful response in XML:

<userAdd>
    <userId>1</userId>
</userAdd>

Error response In JSON:

{"error":{
    "title":"'User Add Failed",
    "message":"You must be an administrator to call this method"}
}

Error response In XML:

<error>
    <title>'User Add Failed</title>
    <message>You must be an administrator to call this method</message>
</error>

Methods in Users and Workspaces