_origen._origen_metal.framework.users#
Functions#
users(): Undocumented.
- _origen._origen_metal.framework.users.users()#
Classes#
Users: To allow origen.users to act as a dict-like property without falling out of syncUser: Undocumented.UserDataset: Undocumented.PopulateUsersReturn: Undocumented.PopulateUserReturn: Undocumented.UsersSessionConfig: Undocumented.UserSessionConfig: Undocumented.
- class _origen._origen_metal.framework.users.Users#
To allow origen.users to act as a dict-like property without falling out of sync with the backend, this class should remain stateless.
- DATA_FIELDS#
- add(id, auto_populate=None)#
- add_dataset(name, config=None, as_topmost=True)#
- add_motive(motive, dataset, replace_existing=False)#
- apply_data_lookup_hierarchy(new_hierarchy)#
- by_role#
- clear_current_user()#
- current#
- current_user#
- current_user_as(new_current)#
- data_lookup_hierarchy#
- datakeys#
- dataset(ds)#
- dataset_for(motive)#
- datasets#
- default_auto_populate#
- default_password_cache_option#
- default_roles#
- default_should_validate_passwords#
- for_exclusive_role(role, required=False)#
- for_role(role, exclusive=False, required=False)#
- get(id)#
- ids#
- initial#
- initial_user#
- items()#
- keys()#
- lookup_current_id(update_current=False)#
- lookup_current_id_function#
- lookup_home_dir_function#
- motives#
- override_default_dataset(name, config=None)#
- populate(repopulate=False, continue_on_error=False, stop_on_failure=False)#
- register_dataset(name, config=None)#
- remove(id)#
- roles#
- session_config#
- set_current_user(u)#
- set_data_lookup_hierarchy(new_hierarchy)#
- unload()#
- users#
- values()#
- class _origen._origen_metal.framework.users.User#
- add_dataset(name, config=None, replace_existing=None, as_topmost=True)#
- add_motive(motive, dataset, replace_existing=False)#
- add_roles(*roles)#
- auto_populate#
- clear_cached_password()#
Clears the cached password only for the default dataset
- clear_cached_passwords()#
Clears all cached passwords for all datasets
- clear_home_dir()#
- data#
- data_lookup_hierarchy#
- data_store#
- datakeys#
- dataset_for(motive)#
- datasets#
- display_name#
- email#
- first_name#
- home_dir#
- id#
- is_current#
- is_current_user#
- last_name#
- motives#
- other#
- password#
Gets the password for the default dataset
- password_for(motive, **kwargs)#
- populate(repopulate=False, continue_on_error=False, stop_on_failure=False)#
- prompt_for_passwords#
- register_dataset(name, config=None, replace_existing=None)#
- remove_roles(*roles)#
- require_home_dir#
- roles#
- session#
- session_config#
- sessions#
- set_home_dir(d=None)#
- should_validate_passwords#
- top_datakey#
- username#
- validate_password()#
- class _origen._origen_metal.framework.users.UserDataset#
- clear_cached_password()#
- clear_home_dir()#
- config#
- data#
- data_store#
- dataset_name#
- display_name#
- email#
- first_name#
- home_dir#
- last_name#
- other#
- password#
Gets the password for this dataset
- populate(repopulate=False, continue_on_error=False, stop_on_failure=False)#
- populate_attempted#
- populate_failed#
- populate_succeeded#
- populated#
- require_home_dir#
- set_home_dir(d=None)#
- should_validate_password#
- username#
- validate_password()#
- class _origen._origen_metal.framework.users.UserDatasetConfig(category=None, data_store=None, auto_populate=None, should_validate_password=None)#
- auto_populate#
- category#
- data_store#
- should_validate_password#
- class _origen._origen_metal.framework.users.PopulateUsersReturn#
- errored#
- errored_datasets#
- errored_outcomes#
- failed#
- failed_datasets#
- failed_outcomes#
- outcomes#
- succeeded#