1. References
  2. HTTP API
  3. AdminUsers
Rate this page:

AdminUsers

Methods

AddAdminUser

Copy URL

Adds a new admin user into the specified parent or child account.

AddAdminUser example
Copy

AddAdminUser example

Add a new admin user.

Parameters

  • new_admin_user_name:

    string

    Optional

    The admin user name. The length must be less than 50.

  • admin_user_display_name:

    string

    Optional

    The admin user display name. The length must be less than 256.

  • new_admin_user_password:

    string

    Optional

    The admin user password. The length must be at least 6 symbols.

  • admin_user_active:

    boolean

    Optional
    Defaults on:  true

    The admin user enable flag.

  • admin_role_id:

    string

    Optional

    The role(s) ID created via Managing Admin Roles methods. The attaching admin role ID list separated by the ';' symbol or the 'all' value.

  • admin_role_name:

    stringlist

    Optional

    The role(s) name(s) created via Managing Admin Roles methods. The attaching admin role name that can be used instead of admin_role_id.

Returns

  • result:

    number

    1

  • admin_user_id:

    number

    The new admin user ID.

  • admin_user_api_key:

    string

    The admin user API key.

DelAdminUser

Copy URL

Deletes the specified admin user.

DelAdminUser example
Copy

DelAdminUser example

Delete the admin user.

Parameters

  • required_admin_user_id:

    intlist

    The admin user ID list separated by the ';' symbol or the 'all' value.

  • required_admin_user_name:

    stringlist

    The admin user name to delete, can be used instead of required_admin_user_id.

Returns

  • result:

    number

    1

SetAdminUserInfo

Copy URL

Edits the specified admin user.

SetAdminUserInfo example
Copy

SetAdminUserInfo example

Edit the admin user password.

Parameters

  • 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.

  • new_admin_user_name:

    string

    Optional

    The new admin user name. The length must be less than 50.

  • admin_user_display_name:

    string

    Optional

    The new admin user display name. The length must be less than 256.

  • new_admin_user_password:

    string

    Optional

    The new admin user password. The length must be at least 6 symbols.

  • admin_user_active:

    boolean

    Optional

    The admin user enable flag.

Returns

  • result:

    number

    1

GetAdminUsers

Copy URL

Gets the admin users of the specified account. Note that both account types - parent and child - could have its own admins.

GetAdminUsers example
Copy

GetAdminUsers example

Get two first admin users.

Parameters

  • required_admin_user_id:

    number

    Optional

    The admin user ID to filter.

  • required_admin_user_name:

    string

    Optional

    The admin user name part to filter.

  • admin_user_display_name:

    string

    Optional

    The admin user display name part to filter.

  • admin_user_active:

    boolean

    Optional

    The admin user active flag to filter.

  • with_roles:

    boolean

    Optional
    Defaults on:  false

    Set true to get the attached admin roles.

  • with_access_entries:

    boolean

    Optional
    Defaults on:  false

    Set true to get the admin user permissions.

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count.

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records will be skipped in the output.

Returns

  • result:

    [AdminUserType]

  • total_count:

    number

    The total found admin user count.

  • count:

    number

    The returned admin user count.

AttachAdminRole

Copy URL

Attaches the admin role(s) to the already existing admin(s).

AttachAdminRole example
Copy

AttachAdminRole example

Bind the all admin users with the admin roles 1, 2 and 3.

Parameters

  • required_admin_user_id:

    intlist

    The admin user ID list separated by the ';' symbol or the 'all' value.

  • required_admin_user_name:

    stringlist

    The admin user name to bind, can be used instead of required_admin_user_id.

  • admin_role_id:

    intlist

    The role(s) ID created via Managing Admin Roles methods. The attached admin role ID list separated by the ';' symbol or the 'all' value.

  • 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

    Optional
    Defaults on:  set

    The merge mode. The following values are possible: add, del, set.

Returns

  • result:

    number

    1