:py:mod:`pywebui.identifiers`
=============================

.. py:module:: pywebui.identifiers


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   pywebui.identifiers.Identifier
   pywebui.identifiers.Holder
   pywebui.identifiers.IdentifiersMethods




.. py:class:: Identifier(attrs)



   Identifier object.

   .. attribute:: GIDValue

      The decimal value of group identifier (GID).

      :type: str

   .. attribute:: name

      The name of identifier.

      :type: str

   .. attribute:: value

      The hex value of identifier.

      :type: str


.. py:class:: Holder(attrs)



   Holder object.

   .. attribute:: attributes

      array of holder's attributes.

      :type: list(str)

   .. attribute:: holder

      name of user (holder) who hold selected identifier

      :type: str


.. py:class:: IdentifiersMethods

   Encapsulates methods for manage identifiers.

   .. py:method:: get_identifiers(self) -> List[Identifier]

      Returns the list of rights identifiers without user UIC's.


   .. py:method:: get_all_identifiers(self) -> List[Identifier]

      Returns the list of all rights identifiers.


   .. py:method:: get_identifier(self, identifier: str) -> Identifier

      Returns identifier by name.


   .. py:method:: get_identifier_holders(self, identifier: str) -> List[Holder]

      Returns the list of users (holders) who hold selected identifier.


   .. py:method:: get_holder_identifiers(self, holder: str) -> List[Identifier]

      Returns the list of identifiers that are held by selected user (holder).

      User can hold one or more identifiers, or no identifiers.


   .. py:method:: create_identifier(self, name: str, value: str, identifier_type: str = Identifier.IDENTIFIER_TYPE, attributes: List[str] = []) -> bool

      Creates the new identifier.


   .. py:method:: delete_identifier(self, identifier) -> bool

      Deletes selected identifier.


   .. py:method:: grant_identifiers(self, username: str, identifiers: List[str]) -> bool

      Grants identifiers to user.


   .. py:method:: rovoke_identifiers(self, username: str, identifiers: List[str]) -> bool

      Revokes identifiers from user.