keycloak.authorization.role

The authorization Role module.

Module Contents

Classes

Role

Authorization Role base class.

class keycloak.authorization.role.Role(name, required=False)[source]

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

Parameters:
  • name (str) – Name

  • required (bool) – Required role indicator

get_name()[source]

Get name.

Returns:

Name

Return type:

str

__eq__(other)[source]

Eq method.

Parameters:

other (str) – The other object

Returns:

Equality bool

Return type:

bool | NotImplemented