keycloak.authorization.role
===========================

.. py:module:: keycloak.authorization.role

.. autoapi-nested-parse::

   The authorization Role module.



Classes
-------

.. autoapisummary::

   keycloak.authorization.role.Role


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

.. py:class:: Role(name: str, required: bool = False)

   Authorization Role base class.

   Roles identify a type or category of user. Admin, user,
   manager, and employee are all typical roles that may exist in an organization.

   https://keycloak.gitbooks.io/documentation/server_admin/topics/roles.html

   :param name: Name
   :type name: str
   :param required: Required role indicator
   :type required: bool


   .. py:attribute:: name


   .. py:attribute:: required
      :value: False



   .. py:method:: get_name() -> str

      Get name.

      :returns: Name
      :rtype: str



   .. py:method:: __eq__(other: str | Role) -> bool

      Eq method.

      :param other: The other object
      :type other: str
      :returns: Equality bool
      :rtype: bool