clc.user
index
/Users//clc_git/src/clc/user.py

User related functions.
 
These user related functions generally align one-for-one with published API calls categorized in the user category
 
API v1 - https://t3n.zendesk.com/forums/21512156-Users
API v2 - n/a

 
Modules
       
clc

 
Classes
       
User

 
class User
     Static methods defined here:
CreateUser(user, email, first_name, last_name, roles, alias=None)
Create new user within a given account.
 
https://t3n.zendesk.com/entries/22441967-CreateUser
 
:param user: user name, which is typically an email address
:param email: email address.  Password credentials are emailed to this address on account creation
:param first_name: first name
:param last_name: surname
:param roles: list of roles (ServerAdministrator, BillingManager, DNSManager, AccountAdministrator,  AccountViewer, NetworkManager, SecurityManager, ServerOperator)
:param alias: short code for a particular account.  If none will use account's default alias
DeleteUser(user)
Delete user associated with a given account.
 
https://t3n.zendesk.com/entries/22454068-DeleteUser
 
:param user: user name, which is typically an email address
GetUserDetails(user, alias=None)
Gets the details of a specific user associated with a given account.
 
https://t3n.zendesk.com/entries/22427672-GetUserDetails
 
:param alias: short code for a particular account.  If none will use account's default alias
:param user: user name, which is typically an email address
GetUsers(alias=None)
Gets all of users assigned to a given account.
 
https://t3n.zendesk.com/entries/22427662-GetUsers
 
:param alias: short code for a particular account.  If none will use account's default alias
SuspendUser(user)
Suspend user associated with a given account.
 
https://t3n.zendesk.com/entries/22422271-SuspendUser
 
:param user: user name, which is typically an email address
UnsuspendUser(user)
Unsuspend user associated with a given account.
 
https://t3n.zendesk.com/entries/21560785-UnsuspendUser
 
:param user: user name, which is typically an email address
UpdateUser(user, email, first_name, last_name, roles, alias=None)
Update existing user within a given account.
 
https://t3n.zendesk.com/entries/22454018-UpdateUser
 
:param alias: short code for a particular account.  If none will use account's default alias
:param user: user name, which is typically an email address
:param email: email address.  Password credentials are emailed to this address on account creation
:param first_name: first name
:param last_name: surname
:param roles: list of roles (ServerAdministrator, BillingManager, DNSManager, AccountAdministrator,  AccountViewer, NetworkManager, SecurityManager, ServerOperator)

Data and other attributes defined here:
user_role_stoi = {'AccountAdministrator': 9, 'AccountViewer': 10, 'BillingManager': 3, 'DNSManager': 8, 'NetworkManager': 12, 'SecurityManager': 13, 'ServerAdministrator': 2, 'ServerOperator': 14}