Represents the main access point to Oxygen API. More...
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. |
Represents the main access point to Oxygen API.
def o2managementlib.O2Agent.login_api_user | ( | self, | |
oxygen_id, | |||
password | |||
) |
Login to Oxygen using a user with admin privileges.
self | The object pointer. |
oxygen_id | Oxygen ID of the user |
password | Password associated with the user |
def o2managementlib.O2Agent.logout | ( | self | ) |
Logout active user.
self | The object pointer. |
def o2managementlib.O2Agent.get_user_info | ( | self | ) |
Get active user information.
self | The object pointer. |
def o2managementlib.O2Agent.create_user | ( | self, | |
oxygen_id, | |||
email, | |||
corporate_user_name, | |||
first_name, | |||
last_name, | |||
password | |||
) |
Creates a new user.
self | The object pointer. |
oxygen_id | Oxygen ID of the new user |
Email address of the new user | |
corporate_user_name | LDAP username (External ID) of the new user (optional for non-LDAP) |
first_name | New user's first name |
last_name | New user's last name |
password | Password of the new user (optional for LDAP) |
def o2managementlib.O2Agent.get_all_users | ( | self | ) |
Gets all users in the active user's company.
self | The object pointer. |
def o2managementlib.O2Agent.get_user_by_oxygen_id | ( | self, | |
oxygen_id | |||
) |
Returns a user by user's Oxygen ID.
self | The object pointer. |
oxygen_id | The 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.
self | The object pointer. |
oxygen_id | The 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.
self | The object pointer. |
oxygen_id | The 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.
self | The object pointer. |
oxygen_id | The 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.
self | The object pointer. |
oxygen_id | Oxygen ID of the new user to be modified |
New email | |
first_name | New first name |
last_name | New last name |
display_name | New display name |