mstrio > access_and_security > privilege

class mstrio.access_and_security.privilege.Privilege(connection, name=None, id=None)

Bases: EntityBase

Object representation of Strategy One object.

Parameters:

• connection (Connection) –

• name (str | None) –

• id (str | None) –

connection

A Strategy One connection object

id

privilege ID

name

privilege name

description

privilege description

categories

privilege category

is_project_level_privilege

specify if privilege is compatible with server configuration level or project level

add_to_user(users)

Add privilege to user.

Parameters:

users (list[Union[ForwardRef('User'), str]]) – list of User objects or names.

Return type:

None

add_to_user_group(groups)

Add privilege to User Group.

Parameters:

groups (list[Union[UserGroup, str]]) – list of UserGroup objects or names.

Return type:

None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

fetch(attr=None)

Fetch the latest object’s state from the I-Server.

Note

This method can overwrite local changes made to the object.

Parameters:

• attr (Optional[str]) – Attribute name to be fetched. If not specified

• dictionary. (it will use all getters specified in _API_GETTERS) –

• None. (Defaults to) –

Raises:

ValueError – If attr cannot be fetched.

Return type:

None

classmethod from_dict(source, connection, to_snake_case=True, with_missing_value=False)

Overrides Dictable.from_dict() to instantiate an object from

a dictionary without calling any additional getters.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (dict[str, Any]) – a dictionary from which an object will be constructed.

• connection (Connection) – A Strategy One Connection object.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case, default True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

classmethod list_privileges(connection, to_dictionary=False, to_dataframe=False, **filters)

Get list of privilege objects or privilege dicts. Filter the privileges by specifying the filters keyword arguments.

Optionally use to_dictionary or to_dataframe to choose output format.

Parameters:

• connection (Connection) – Strategy One connection object returned by connection.Connection().

• to_dictionary (bool) – If True returns dict, by default (False) returns User objects.

• to_dataframe (bool) – If True, returns DataFrame.

• **filters – Available filter parameters: [‘id’, ‘name’, ‘description’, ‘is_project_level_privilege’]

Return type:

list[Privilege] | list[dict] | DataFrame

Examples

>>> Privilege.list_privileges(connection, to_dataframe=True,
>>>                           is_project_level_privilege='True',
>>>                           id=[1,2,3,4,5])

list_properties(excluded_properties=None)

Fetches all attributes from the server and converts all properties of the object to a dictionary.

Parameters:

excluded_properties (list[str], optional) – A list of object properties that should be excluded from the dict. Defaults to None.

Returns:

A dictionary which keys are object’s attribute names, and

which values are object’s attribute values.

Return type:

dict

print()

Pretty Print all properties of the object.

Return type:

None

revoke_from_user(users)

Revoke privilege from user.

Parameters:

users (list[Union[ForwardRef('User'), str]]) – list of User objects or names.

Return type:

None

revoke_from_user_group(groups)

Revoke privilege from User Group.

Parameters:

groups (list[Union[UserGroup, str]]) – list of UserGroup objects or names.

Return type:

None

classmethod to_csv(objects, name, path=None, properties=None)

Exports MSTR objects to a csv file.

Optionally, saves only the object properties specified in the properties parameter.

Parameters:

• objects (T | list[T]) – List of objects of the same type that

• exported. (will be) –

• name (str) – The name of the csv file ending with ‘.csv’

• path (Optional[str], optional) – A path to the directory where the file will be saved. Defaults to None.

• properties (Optional[list[str]], optional) – A list of object’s attribute names that should be included in the exported file. Defaults to None.

Raises:

• TypeError – If objects is not of type T or list of type T

• objects. –

Return type:

None

to_dataframe()

Converts all properties of the object to a dataframe.

Returns:

A DataFrame object containing object properties.

Return type:

DataFrame

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

update_properties()

Save compatible local changes of the object attributes to the I-Server. Changes are retrieved from the self._altered_properties dictionary. After the process of update has finished, self._altered_properties is cleared. For this method to work properly, you must override the _alter_properties() method in a subclass.

Raises:

requests.HTTPError – If I-Server raises exception

Return type:

None

class mstrio.access_and_security.privilege.PrivilegeList(connection)

Bases: object

Class for browsing MSTR privileges.

Parameters:

connection (Connection) –

connection

A Strategy One connection object

to_dataframe()

Returns DataFrame with privileges.

to_dict()

Returns list of privileges dicts.