keycloak.authorization.permission
=================================

.. py:module:: keycloak.authorization.permission

.. autoapi-nested-parse::

   Keycloak authorization Permission module.



Classes
-------

.. autoapisummary::

   keycloak.authorization.permission.Permission


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

.. py:class:: Permission(name: str, type: str, logic: str, decision_strategy: str)

   Base permission class.

   Consider this simple and very common permission:

   A permission associates the object being protected with the policies that must be evaluated to
   determine whether access is granted.

   X CAN DO Y ON RESOURCE Z

   where

   - X represents one or more users, roles, or groups, or a combination of them. You can
       also use claims and context here.

   - Y represents an action to be performed, for example, write, view, and so on.

   - Z represents a protected resource, for example, "/accounts".

   https://keycloak.gitbooks.io/documentation/authorization_services/topics/permission/overview.html

   :param name: Name
   :type name: str
   :param type: Type
   :type type: str
   :param logic: Logic
   :type logic: str
   :param decision_strategy: Decision strategy
   :type decision_strategy: str



   .. py:property:: name
      :type: str


      Get name.

      :returns: name
      :rtype: str



   .. py:property:: type
      :type: str


      Get type.

      :returns: type
      :rtype: str



   .. py:property:: logic
      :type: str


      Get logic.

      :returns: Logic
      :rtype: str



   .. py:property:: decision_strategy
      :type: str


      Get decision strategy.

      :returns: Decision strategy
      :rtype: str



   .. py:property:: resources
      :type: list


      Get resources.

      :returns: Resources
      :rtype: list



   .. py:property:: scopes
      :type: list


      Get scopes.

      :returns: Scopes
      :rtype: list



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

      Repr method.

      :returns: Class representation
      :rtype: str



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

      Str method.

      :returns: Class string representation
      :rtype: str