Page History
...
Parameter | Type | Description | ||
|---|---|---|---|---|
distinguished_name | string | When creating a new user, this parameter specifies the LDAP distinguished name. | ||
user_password | string | When creating a new user, this parameter specifies their initial Flow password. If this parameter is absent and this is not an LDAP user then the user will receive an email with a link to set their initial password. | ||
string | The user’s email address. When creating a new user, this parameter is required. | |||
display_name | string | The name that other users will see. | ||
enabled | boolean | Whether the user is able to log in. | ||
admin | boolean | Whether the user has the admin role. The system requires at least one admin accountadd_role_name add_role_id | string integer | Add the user to the specified role. |
remove_role_name remove_role_id | string integer | Remove the user from the specified role. | ||
private_directory | string | If present, the directory will be created and the user will be given permission to use it. | ||
| add_directory | string | Add permission for the user to browse files in this directory. | ||
quota | integer | The size of the user’s quota (in gigabytes) or “none” to remove any quota | ||
notify_when_tasks_finish | boolean | Whether the user will receive an email when a task they have queued completes | ||
notify_when_added_to_project | boolean | Whether the user will receive an email when they are added as a collaborator or viewer to a project | ||
decimal_precison | integer | How many digits to show after the decimal point for numeric values in tables |
...
200: application/json
id, name, displayName, email, isOnline, tasksInQueue, diskQuota, diskUsage (in gigabytes), roles
/users/roles
GET
Returns information about all roles
Responses
200: application/json
name, id
/users/logins
GET
Returns information about all users logged into the system
...
id, name, displayName, isOnline, tasksInQueue, diskQuota, diskUsage (in gigabytes)
Permissions
/permissions/add_directory
/permissions/remove_directory
POST, PUT
Configure directory permissions
Required parameters
Parameter | Type | Description |
|---|---|---|
| directory | string | A folder on the server |
user_name OR user_id OR group_name OR group_id | string integer string integer | The name of a user The ID of a user The name of a group The id of a group |
/permissions/enforce
POST, PUT
Turn on and off enforcement of directory permissions
Required parameters
Parameter | Type | Description |
|---|---|---|
| enforce | boolean | If true, users will only be able to view directories for which they are granted permission. If false, users will be able to view all directories. |
Tasks
/tasks
POST, GET
Returns a summary of tasks run on the server
...
Overview
Content Tools