AdminUsers
Methods
AddAdminUser
Adds a new admin user into the specified parent or child account.
Parameters
admin_role_id:
string
OptionalThe role(s) ID created via Managing Admin Roles methods. The attaching admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles
admin_role_name:
stringlist
OptionalThe role(s) name(s) created via Managing Admin Roles methods. The attaching admin role name that can be used instead of admin_role_id
admin_user_active:
boolean
OptionalDefaults on: trueWhether the admin user is active
admin_user_display_name:
string
The admin user display name. The length must be less than 256
new_admin_user_name:
string
The admin user name. The length must be less than 50
new_admin_user_password:
string
The admin user password. The length must be at least 6 symbols
Returns
admin_user_api_key:
string
The admin user API key
admin_user_id:
number
The new admin user ID
result:
number
1
AttachAdminRole
Attaches the admin role(s) to the already existing admin(s).
Parameters
admin_role_id:
intlist
The role(s) ID created via Managing Admin Roles methods. The attached admin role ID list separated by semicolons (;). Use the 'all' value to select alladmin roles
admin_role_name:
stringlist
The role(s) name(s) created via Managing Admin Roles methods. The admin role name to attach, can be used instead of admin_role_id
mode:
string
OptionalDefaults on: setThe merge mode. The following values are possible: add, del, set
required_admin_user_id:
intlist
The admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users
required_admin_user_name:
stringlist
The admin user name to bind, can be used instead of required_admin_user_id
Returns
result:
number
1
DelAdminUser
Deletes the specified admin user.
Parameters
required_admin_user_id:
intlist
The admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users
required_admin_user_name:
stringlist
The admin user name to delete, can be used instead of required_admin_user_id
Returns
result:
number
1
GetAdminUsers
Gets the admin users of the specified account. Note that both account types - parent and child - can have its own admins.
Parameters
admin_user_active:
boolean
OptionalWhether the admin user is active to filter
admin_user_display_name:
string
OptionalThe admin user display name part to filter
count:
number
OptionalDefaults on: 20The max returning record count
offset:
number
OptionalDefaults on: 0The first N records are skipped in the output
required_admin_user_id:
number
OptionalThe admin user ID to filter
required_admin_user_name:
string
OptionalThe admin user name part to filter
with_access_entries:
boolean
OptionalDefaults on: falseWhether to get the admin user permissions
with_roles:
boolean
OptionalDefaults on: falseWhether to get the attached admin roles
Returns
count:
number
The returned admin user count
result:
total_count:
number
The total found admin user count
SetAdminUserInfo
Edits the specified admin user.
Parameters
admin_user_active:
boolean
OptionalWhether the admin user is active
admin_user_display_name:
string
OptionalThe new admin user display name. The length must be less than 256
new_admin_user_name:
string
OptionalThe new admin user name. The length must be less than 50
new_admin_user_password:
string
OptionalThe new admin user password. The length must be at least 6 symbols
required_admin_user_id:
number
The admin user to edit
required_admin_user_name:
string
The admin user to edit, can be used instead of required_admin_user_id
Returns
result:
number
1