SIGN UP

Managing Admin Users

Methods

AddAdminUser

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

Parameters

  • Follow link for authentication parameter names and details.

  • new_admin_user_name:

    string

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

  • admin_user_display_name:

    string

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

  • new_admin_user_password:

    string

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

  • admin_user_active:

    boolean
    Optional
    Defaults to 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:

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

Examples

request:

Add a new admin user.

https://api.voximplant.com/platform_api/AddAdminUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&new_admin_user_name=adm1&admin_user_display_name=adm1&new_admin_user_password=1234567&admin_role_id=1

response:

{
    "result": 1,
    "admin_user_id": 1,
    "admin_user_api_key": "02486488-add3-4567-b72f-6259f9a9c92f"
}

AttachAdminRole

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

Parameters

  • Follow link for authentication parameter names and details.

  • required_admin_user_id:

    string

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

  • required_admin_user_name:

    string

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

  • admin_role_id:

    string

    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:

    string

    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 to set

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

Returns

  • result:

    number

    1

Examples

request:

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

https://api.voximplant.com/platform_api/AttachAdminRole/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&required_admin_user_id=all;&admin_role_id=1;2;3

response:

Success

{
    "result": 1
}

DelAdminUser

Deletes the specified admin user.

Parameters

  • Follow link for authentication parameter names and details.

  • required_admin_user_id:

    string

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

  • required_admin_user_name:

    string

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

Returns

  • result:

    number

    1

Examples

request:

Delete the admin user.

https://api.voximplant.com/platform_api/DelAdminUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&required_admin_user_id=1

response:

Success

{
    "result": 1
}

GetAdminUsers

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

Parameters

  • Follow link for authentication parameter names and details.

  • 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 to false

    Set true to get the attached admin roles.

  • with_access_entries:

    boolean
    Optional
    Defaults to false

    Set true to get the admin user permissions.

  • count:

    number
    Optional
    Defaults to 20

    The max returning record count.

  • offset:

    number
    Optional
    Defaults to 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.

Examples

request:

Get two first admin users.

https://api.voximplant.com/platform_api/GetAdminUsers/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&with_access_entries=true&count=2

response:

{
    "count": 2,
    "result": [
        {
            "modified": "2014-12-05 10:27:30",
            "admin_user_id": 1,
            "access_entries": [
                "GetAccountInfo",
                "GetCallHistory"
            ],
            "admin_user_name": "adm1",
            "admin_user_active": true,
            "admin_user_display_name": "adm1"
        },
        {
            "modified": "2014-12-05 10:27:30",
            "admin_user_id": 2,
            "access_entries": [
                "GetAccountInfo",
                "SetAccountInfo"
            ],
            "admin_user_name": "adm2",
            "admin_user_active": true,
            "admin_user_display_name": "adm2"
        }
    ],
    "total_count": 2
}

SetAdminUserInfo

Edits the specified admin user.

Parameters

  • Follow link for authentication parameter names and details.

  • 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

Examples

request:

Edit the admin user password.

https://api.voximplant.com/platform_api/SetAdminUserInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&required_admin_user_id=1&new_admin_user_password=7654321

response:

Success

{
    "result": 1
}