User DB API class

class cdb.common.db.api.userDbApi.UserDbApi
addGroup(*args, **kwargs)

add a new user group record.

Parameters:
  • name –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
addUser(*args, **kwargs)

Add a new user record.

Parameters:
  • username –
  • firstName –
  • lastName –
  • middleName –
  • email –
  • description –
  • password –
  • kwargs –
Returns:

(CdbObject) newly added record.
addUserToGroup(*args, **kwargs)

Assign a user to a particular group.

Parameters:
  • username –
  • groupName –
  • kwargs –
Returns:

(CdbObject) newly added record.
getUserById(*args, **kwargs)

Get a user record by its id.

Parameters:
  • id –
  • kwargs –
Returns:

(CdbObject) resulting record.
getUserByUsername(*args, **kwargs)

Get a user record by its username attribute.

Parameters:
  • username –
  • kwargs –
Returns:

(CdbObject) resulting record.
getUserGroupByName(*args, **kwargs)

Get a user group record by its name.

Parameters:
  • name –
  • kwargs –
Returns:

(CdbObject) resulting record.
getUserGroups(*args, **kwargs)

Get all user group records.

Parameters:kwargs –
Returns:CdbObject List of resulting records.
getUsers(*args, **kwargs)

Get all user records.

Parameters:kwargs –
Returns:CdbObject List of resulting records.