Notice: Each user has a certain role in the system. Each role determines the user’s privileges. Depending on the role, the user may not be able to list or display other users that are not “visible” to him/her.
- Authentication: The user must be authenticated to perform this action.
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id required |
ID of the user to be displayed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
user optional , nil allowed |
Validations:
|
|
user[username] required |
User’s login name. Validations:
|
|
user[password] optional , nil allowed |
User’s password. Validations:
|
|
user[password_confirmation] optional , nil allowed |
User’s password confirmation. Validations:
|
|
user[role_id] required |
The string determining user’s role in the application. Validations:
|
|
user[firstname] optional , nil allowed |
User’s first name. Validations:
|
|
user[lastname] optional , nil allowed |
User’s last name. Validations:
|
|
user[user_matrix_attributes] optional , nil allowed |
Capabilities of this specific user. Overrides role capabilities. Validations:
|
|
user[skies_tier] optional , nil allowed |
User’s Skies tier. Validations:
|
|
user[authentication_method] optional , nil allowed |
Optionally set the authentication method to: ldap,openid. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
user optional , nil allowed |
Validations:
|
|
user[username] optional |
User’s login name. Validations:
|
|
user[password] optional , nil allowed |
User’s password. Validations:
|
|
user[password_confirmation] optional , nil allowed |
User’s password confirmation. Validations:
|
|
user[role_id] optional |
The string determining user’s role in the application. Validations:
|
|
user[firstname] optional , nil allowed |
User’s first name. Validations:
|
|
user[lastname] optional , nil allowed |
User’s last name. Validations:
|
|
user[user_matrix_attributes] optional , nil allowed |
Capabilities of this specific user. Overrides role capabilities. Validations:
|
|
user[skies_tier] optional , nil allowed |
User’s Skies tier. Validations:
|
|
user[authentication_method] optional , nil allowed |
Optionally set the authentication method to: ldap,openid. Validations:
|
|
team_id optional |
Optionally the team to assign to the new user. Validations:
|
|
message optional |
Optional message to attach to the invitation. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id required |
ID of the user to be updated. Validations:
|
|
user optional , nil allowed |
Validations:
|
|
user[username] optional |
User’s login name. Validations:
|
|
user[password] optional , nil allowed |
User’s password. Validations:
|
|
user[password_confirmation] optional , nil allowed |
User’s password confirmation. Validations:
|
|
user[role_id] optional |
The string determining user’s role in the application. Validations:
|
|
user[firstname] optional , nil allowed |
User’s first name. Validations:
|
|
user[lastname] optional , nil allowed |
User’s last name. Validations:
|
|
user[user_matrix_attributes] optional , nil allowed |
Capabilities of this specific user. Overrides role capabilities. Validations:
|
|
user[skies_tier] optional , nil allowed |
User’s Skies tier. Validations:
|
|
user[authentication_method] optional , nil allowed |
Optionally set the authentication method to: ldap,openid. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id required |
ID of the user to be deleted. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
user_id required |
ID of the user to be added to a team. Validations:
|
|
team_id required |
ID of the team to add the user to. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
user_id required |
ID of the user to be removed from a team. Validations:
|
|
team_id required |
ID of the team from which the user is to be removed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id required |
ID of the user. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id required |
ID of the user. Validations:
|
Access: The user may retrieve their own user settings. For viewing someone else's settings, the user has to be an administrator.
Access: The user may update their own user settings. To update someone else's settings, the user has to be an administrator.
| Param name | Description |
|---|---|
|
settings required |
Hash of the user settings. Allowed keys are [background, sync_interval, show_scanlines, proxy_seeking, thumbnail_width, disable_safe_search, build_project_name_from_custom_metadata, hide_archived_content, project_display, panel_import_method, list_display, auto_import_unmanged_media, auto_import_unmanged_media_interval, auto_link_library_media, auto_link_library_media_interval, auto_link_subproject_media, auto_link_subproject_media_interval, on_asset_double_click, timecode_position, search_tabs, asset_ordering, unsubscribe_from_assets_after, unsubscribe_from_projects_after, unsubscribe_from_galleries_after, project_session]. Validations:
|
Access: The user may change their own background. To set someone else's background, the user has to be an administrator.