Oxygen Python Management SDK
All Classes Functions Variables
Public Member Functions
o2managementlib.O2Agent Class Reference

Represents the main access point to Oxygen API. More...

List of all members.

Public Member Functions

def login_api_user
 Login to Oxygen using a user with admin privileges.
def logout
 Logout active user.
def get_user_info
 Get active user information.
def create_user
 Creates a new user.
def get_all_users
 Gets all users in the active user's company.
def get_user_by_oxygen_id
 Returns a user by user's Oxygen ID.
def disable_user_by_oxygen_id
 Disables a user by user's Oxygen ID.
def enable_user_by_oxygen_id
 Enables a disabled user by user's Oxygen ID.
def delete_user_by_oxygen_id
 Deletes a user by user's Oxygen ID.
def update_user_details_by_oxygen_id
 Modifies a user's details : email, first name, last name, display name.

Detailed Description

Represents the main access point to Oxygen API.


Member Function Documentation

def o2managementlib.O2Agent.login_api_user (   self,
  oxygen_id,
  password 
)

Login to Oxygen using a user with admin privileges.

Parameters:
selfThe object pointer.
oxygen_idOxygen ID of the user
passwordPassword associated with the user

Logout active user.

Parameters:
selfThe object pointer.

Get active user information.

Parameters:
selfThe object pointer.
Returns:
O2UserInfo The active user information
def o2managementlib.O2Agent.create_user (   self,
  oxygen_id,
  email,
  corporate_user_name,
  first_name,
  last_name,
  password 
)

Creates a new user.

Parameters:
selfThe object pointer.
oxygen_idOxygen ID of the new user
emailEmail address of the new user
corporate_user_nameLDAP username (External ID) of the new user (optional for non-LDAP)
first_nameNew user's first name
last_nameNew user's last name
passwordPassword of the new user (optional for LDAP)
Returns:
O2UserInfo of the new user

Gets all users in the active user's company.

Parameters:
selfThe object pointer.
def o2managementlib.O2Agent.get_user_by_oxygen_id (   self,
  oxygen_id 
)

Returns a user by user's Oxygen ID.

Parameters:
selfThe object pointer.
oxygen_idThe Oxygen ID of the user to be retrieved
def o2managementlib.O2Agent.disable_user_by_oxygen_id (   self,
  oxygen_id 
)

Disables a user by user's Oxygen ID.

Parameters:
selfThe object pointer.
oxygen_idThe Oxygen ID of the user to be disabled
def o2managementlib.O2Agent.enable_user_by_oxygen_id (   self,
  oxygen_id 
)

Enables a disabled user by user's Oxygen ID.

Parameters:
selfThe object pointer.
oxygen_idThe Oxygen ID of the user to be enabled
def o2managementlib.O2Agent.delete_user_by_oxygen_id (   self,
  oxygen_id 
)

Deletes a user by user's Oxygen ID.

Parameters:
selfThe object pointer.
oxygen_idThe Oxygen ID of the user to be deleted
def o2managementlib.O2Agent.update_user_details_by_oxygen_id (   self,
  oxygen_id,
  email,
  first_name,
  last_name,
  display_name 
)

Modifies a user's details : email, first name, last name, display name.

Parameters:
selfThe object pointer.
oxygen_idOxygen ID of the new user to be modified
emailNew email
first_nameNew first name
last_nameNew last name
display_nameNew display name
Returns:
O2UserInfo of the modified user
 All Classes Functions Variables