/Classes/session

Classes / session / index.html

A session

Fields

string uuid
Unique identifier/object reference
host this_host
Currently connected host
user this_user
Currently connected user
datetime last_active
Timestamp for last time session was active
bool pool
True if this session relates to a intra-pool login, false otherwise
Map[string,string] other_config
additional configuration
bool is_local_superuser
true iff this session was created using local superuser credentials
subject subject
references the subject instance that created the session. If a session instance has is_local_superuser set, then the value of this field is undefined.
datetime validation_time
time when session was last validated
string auth_user_sid
the subject identifier of the user that was externally authenticated. If a session instance has is_local_superuser set, then the value of this field is undefined.
string auth_user_name
the subject name of the user that was externally authenticated. If a session instance has is_local_superuser set, then the value of this field is undefined.
Set[string] rbac_permissions
list with all RBAC permissions for this session
Set[task] tasks
list of tasks created using the current session
session parent
references the parent session that created this session

Implicit messages

Record[session] get_record (session session_id, session self)
Get a record containing the current state of the given session.
session get_by_uuid (session session_id, string uuid)
Get a reference to the session instance with the specified UUID.

Explicit messages

session login_with_password (string uname, string pwd, string version)
Attempt to authenticate the user, returning a session reference if successful
void logout (session session_id)
Log out of a session
void change_password (session session_id, string old_pwd, string new_pwd)
Change the account password; if your session is authenticated with root priviledges then the old_pwd is validated and the new_pwd is set regardless
session slave_local_login_with_password (string uname, string pwd)
Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host.
void local_logout (session session_id)
Log out of local session.
Set[string] get_all_subject_identifiers (session session_id)
Return a list of all the user subject-identifiers of all existing sessions
void logout_subject_identifier (session session_id, string subject_identifier)
Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function