UserAdministration

modify

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.modify"

input

• Integer user_id
• User user

output

• User user

errors

• UserNameException
• QuotaNotAllowed

Json example

Input

ouput

import_from_domain

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.import_from_domain"

input

• List<DomainUser> users

output

• List<ImportUserError> errors

errors

• DomainError

Json example

Input

ouput

list

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.list"

input

• List<Unicode> with_parameters
• ListInfo list_info

output

• ResultSet<User> user_list

Search Criteria

• id: Integer
• type: UserType
• login: Unicode
• group_id: Integer
• exclude_group_id: Integer
• no_access_share_id: Integer
• exclude_no_access_share_id: Integer
• read_only_share_id: Integer
• exclude_read_only_share_id: Integer
• read_write_share_id: Integer
• exclude_read_write_share_id: Integer

Order by Criteria

• login: Unicode
• email: Unicode
• firstname: Unicode
• lastname: Unicode

errors

None

Json example

Input

ouput

remove

remove a user

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.remove"

input

• Integer user_id

output

• None

errors

None

Json example

Input

ouput

list_users_from_domain

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.list_users_from_domain"

input

• List<Unicode> with_parameters
• ListInfo list_info

output

• ResultSet<DomainUser> user_list

Search Criteria

• name: Unicode
• login: Unicode

errors

• DomainError

Json example

Input

ouput

check_name_availability

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.check_name_availability"

input

• Unicode name

output

• Boolean is_available

errors

None

Json example

Input

ouput

get_max_users_count

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.get_max_users_count"

input

• None

output

• Integer max_count

errors

None

Json example

Input

ouput

change_password

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.change_password"

input

• Integer user_id
• Unicode password

output

• None

errors

None

Json example

Input

ouput

get_user_by_login

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.get_user_by_login"

input

• Unicode login

output

• User user

errors

• UserNotFound

Json example

Input

ouput

add_local_user

add a user

Access

admin application

url:

"api/external/7.0/authentication.users.Administration.add_local_user"

input

• User user

output

• User user

errors

• UserNameException
• QuotaNotAllowed

Json example

Input

ouput