Security Interface API¶
Interfaces¶
Main API¶
-
class
security_interface.api.
Security
(identity_policy: security_interface.IdentityPolicyInterface, autz_policy: security_interface.AuthorizationPolicyInterface)¶ Bases:
object
-
can
(identity, permission) → bool¶ Check user permissions.
Returns: Return True
if the identity is allowed the permission, else returnFalse
.
Work like
Security.identity()
but when check is failed raiseUnauthorizedError()
exception.Parameters: identity – Claim Returns: Checked claim or return None
Raise: UnauthorizedError()
-
check_permission
(identity, permission)¶ Work like
Security.can()
but when check is failed raiseForbiddenError()
exception.Parameters: - identity – Claim
- permission – Permission
Returns: Checked claim
Raise: ForbiddenError()
-
identify
(identity)¶ Return the claimed identity of the user associated request or
None
if no identity can be found associated with the request.Parameters: identity – Claim Returns: Return checked identity or None
if check is failed.
-
is_anonymous
(identity) → bool¶ Parameters: identity – Claim Returns: Return True
if user anonymous otherwiseFalse
-