/Classes/subject

Classes / subject / index.html

A user or group that can log in xapi

Fields

string uuid
Unique identifier/object reference
string subject_identifier
the subject identifier, unique in the external directory service
Map[string,string] other_config
additional configuration
Set[role] roles
the roles associated with this subject

Implicit messages

Record[subject] get_record (session session_id, subject self)
Get a record containing the current state of the given subject.
subject get_by_uuid (session session_id, string uuid)
Get a reference to the subject instance with the specified UUID.
subject create (session session_id, string subject_identifier, Map[string,string] other_config)
Create a new subject instance, and return its handle.
void destroy (session session_id, subject self)
Destroy the specified subject instance.
Set[subject] get_all (session session_id)
Return a list of all the subjects known to the system.
Map[subject,Record[subject]] get_all_records (session session_id)
Return a map of subject references to subject records for all subjects known to the system.

Explicit messages

void add_to_roles (session session_id, subject self, role role)
This call adds a new role to a subject
void remove_from_roles (session session_id, subject self, role role)
This call removes a role from a subject
Set[string] get_permissions_name_label (session session_id, subject self)
This call returns a list of permission names given a subject