pykazoo.users

class pykazoo.users.Users(rest_request)

2600hz Kazoo Users API.

Parameters:rest_request (pykazoo.restrequest.RestRequest) – The request client to use. (optional, default: pykazoo.RestRequest())
create_user(account_id, data)

Create a User

Parameters:
  • account_id (str) – ID of Account to create User for.
  • data (dict) – Kazoo User data (see official API Docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
delete_user(account_id, user_id)

Deletes a User

Parameters:
  • account_id (str) – ID of Account to delete User from.
  • user_id (str) – ID of User to delete.
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_user(account_id, user_id, filters=None)

Get a specific User for an Account.

Parameters:
  • account_id (str) – ID of Account to get User for.
  • user_id (str) – ID of the User to get.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
get_users(account_id, filters=None)

Get all Users for an Account.

Parameters:
  • account_id (str) – ID of Account to get Users for.
  • filters (dict, None) – Kazoo Filter Parameters (see official API docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict
update_user(account_id, user_id, data)

Updates a User

Parameters:
  • account_id (str) – ID of Account to update User for.
  • user_id (str) – ID of User to update.
  • data (dict) – Kazoo Account data (see official API Docs).
Returns:

Kazoo Data (see official API docs).
Return type:

dict