keycloak.authorization.permission#

Keycloak authorization Permission module.

Classes#

Permission

Base permission class.

Module Contents#

class keycloak.authorization.permission.Permission(name: str, type: str, logic: str, decision_strategy: str)[source]#

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

Parameters:
  • name (str) – Name

  • type (str) – Type

  • logic (str) – Logic

  • decision_strategy (str) – Decision strategy

property name: str[source]#

Get name.

Returns:

name

Return type:

str

property type: str[source]#

Get type.

Returns:

type

Return type:

str

property logic: str[source]#

Get logic.

Returns:

Logic

Return type:

str

property decision_strategy: str[source]#

Get decision strategy.

Returns:

Decision strategy

Return type:

str

property resources: list[source]#

Get resources.

Returns:

Resources

Return type:

list

property scopes: list[source]#

Get scopes.

Returns:

Scopes

Return type:

list

__repr__() str[source]#

Repr method.

Returns:

Class representation

Return type:

str

__str__() str[source]#

Str method.

Returns:

Class string representation

Return type:

str