models.user_information module

class models.user_information.UserInformation(include_subtenant_objects=None, pulse_attribute_vec=None, sid_vec=None, tenant_id_vec=None)

Bases: object

Implementation of the ‘UserInformation’ model.

A message to encapsulate information about the user who made the request. Request should be filtered by these fields if specified so that only the objects that the user is permissioned for are returned. If both sid_vec & tenant_id are specified then an intersection of respective results should be returned.

Attributes:

include_subtenant_objects (bool): Whether objects owned by subtenants

should be returned. This would require a prefix search with the passed tenant_id. All tenants are considered sub-tenants of the admin. For GET requests, if tenant id is empty(admin user is querying) and if this flag is false, we will only return untagged objects. If it is true, we will return everything.

pulse_attribute_vec (list of KeyValuePair): Specifies the KeyValuePair

that client (eg. Iris) wants to persist along with the corresponding (soon-to-be-created) Pulse task for the current action. Eg. pulse_attribute_vec can drive user notifications by associating a Pulse Task with user SID and later Pulse can be searched by client specified Sid to get all finished tasks for the logged in user.

sid_vec (list of ClusterConfigProtoSID): If specified, only the

objects associated with these SIDs should be returned.

tenant_id_vec (list of string): If specified, only the objects

associated with this tenant should be returned. A given tenant ID is always a prefix of the ids of its subtenants. Eg. if tenant_id of cluster admin is empty string then it will be a prefix match for all the tenants on the cluster.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.