AdminRoles
Methods
AddAdminRole
Adds a new admin role.
Parameters
admin_role_active:
boolean
OptionalDefaults on: trueWhether the admin role is enabled. If false the allowed and denied entries have no affect
admin_role_name:
string
The admin role name. The length must be less than 50
allowed_entries:
stringlist
OptionalThe list of allowed access entries separated by semicolons (;) (the API function names)
denied_entries:
stringlist
OptionalThe list of denied access entries separated by semicolons (;) (the API function names)
like_admin_role_id:
intlist
OptionalThe admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles. The list specifies the roles from which the new role automatically copies all permissions (allowed_entries and denied_entries)
like_admin_role_name:
stringlist
OptionalThe admin role name that can be used instead of like_admin_role_id. The name specifies a role from which the new role automatically copies all permissions (allowed_entries and denied_entries)
Returns
admin_role_id:
number
The new admin role ID
result:
number
1
DelAdminRole
Deletes the specified admin role.
Parameters
admin_role_id:
intlist
The admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles
admin_role_name:
stringlist
The admin role name to delete, can be used instead of admin_role_id
Returns
result:
number
1
GetAdminRoles
Gets the admin roles.
Parameters
admin_role_active:
boolean
OptionalWhether the admin role is enabled to filter
admin_role_id:
number
OptionalThe admin role ID to filter
admin_role_name:
string
OptionalThe admin role name part to filter
count:
number
OptionalDefaults on: 20The max returning record count
excluded_admin_user_id:
intlist
OptionalNot attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users
full_admin_users_matching:
string
OptionalDefaults on: falseSet false to get roles with partial admin user list matching
included_admin_user_id:
intlist
OptionalThe attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users
offset:
number
OptionalDefaults on: 0The first N records are skipped in the output
showing_admin_user_id:
number
OptionalThe admin user to show in the 'admin_users' field output
with_account_roles:
boolean
OptionalDefaults on: trueWhether to include the account roles
with_entries:
boolean
OptionalDefaults on: falseWhether to get the permissions
with_parent_roles:
boolean
OptionalDefaults on: trueWhether to include the parent roles
Returns
count:
number
The returned admin role count
result:
total_count:
number
The total found admin role count
GetAvailableAdminRoleEntries
Gets the all available admin role entries.
Returns
result:
[string]
Array of the admin role entries
SetAdminRoleInfo
Edits the specified admin role.
Parameters
admin_role_active:
boolean
OptionalWhether the admin role is enabled. If false the allowed and denied entries have no affect
admin_role_id:
number
The admin role to edit
admin_role_name:
string
The admin role to edit, can be used instead of admin_role_id
allowed_entries:
stringlist
OptionalThe list of allowed access entry changes separated by semicolons (;) (the API function names)
denied_entries:
stringlist
OptionalThe list of denied access entry changes separated by semicolons (;) (the API function names)
entry_modification_mode:
string
OptionalDefaults on: setThe modification mode of the permission lists (allowed_entries and denied_entries). The following values are possible: add, del, set
like_admin_role_id:
intlist
OptionalThe admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles. The list specifies the roles from which the allowed_entries and denied_entries are merged
like_admin_role_name:
stringlist
OptionalThe admin role name, can be used instead of like_admin_role_id. The name specifies a role from which the allowed_entries and denied_entries are merged
new_admin_role_name:
string
OptionalThe new admin role name. The length must be less than 50
Returns
result:
number
1