pyrax
Python Bindings for the Rackspace Cloud
 All Classes Namespaces Files Functions Variables Properties
Public Member Functions | Public Attributes
RaxIdentity Class Reference

This class handles all of the authentication requirements for working with the Rackspace Cloud. More...

Inheritance diagram for RaxIdentity:
FakeRaxIdentity

List of all members.

Public Member Functions

def authenticate
 If the user's credentials include an API key, the default behavior will work.
def auth_with_token
 If a valid token is already known, this call will use it to generate the service catalog.
def find_user_by_name
 Returns a User object by searching for the supplied user name.
def find_user_by_email
 Returns a User object by searching for the supplied user's email address.
def find_user_by_id
 Returns a User object by searching for the supplied user ID.
def get_user
 Returns the user specified by either ID, username or email.
def update_user
 Allows you to update settings for a given user.
def reset_api_key
 Resets the API key for the specified user, or if no user is specified, for the current user.

Public Attributes

 username
 password
 authenticated

Detailed Description

This class handles all of the authentication requirements for working with the Rackspace Cloud.


Member Function Documentation

def auth_with_token (   self,
  token,
  tenant_id = None,
  tenant_name = None 
)

If a valid token is already known, this call will use it to generate the service catalog.

def authenticate (   self,
  username = None,
  password = None,
  api_key = None,
  tenant_id = None 
)

If the user's credentials include an API key, the default behavior will work.

But if they are using a password, the initial attempt will fail, so try again, but this time using the standard password format.

def find_user_by_email (   self,
  email 
)

Returns a User object by searching for the supplied user's email address.

Returns None if there is no match for the given ID.

def find_user_by_id (   self,
  uid 
)

Returns a User object by searching for the supplied user ID.

Returns None if there is no match for the given ID.

def find_user_by_name (   self,
  name 
)

Returns a User object by searching for the supplied user name.

Returns None if there is no match for the given name.

def get_user (   self,
  user_id = None,
  username = None,
  email = None 
)

Returns the user specified by either ID, username or email.

Since more than user can have the same email address, searching by that term will return a list of 1 or more User objects. Searching by username or ID will return a single User.

If a user_id that doesn't belong to the current account is searched for, a Forbidden exception is raised. When searching by username or email, a NotFound exception is raised if there is no matching user.

def reset_api_key (   self,
  user = None 
)

Resets the API key for the specified user, or if no user is specified, for the current user.

Returns the newly-created API key.

Resetting an API key does not invalidate any authenticated sessions, nor does it revoke any tokens.

def update_user (   self,
  user,
  email = None,
  username = None,
  uid = None,
  defaultRegion = None,
  enabled = None 
)

Allows you to update settings for a given user.


Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties