Package-level declarations

Types

class AuthorizationPolicy<Principal : Any>

An authorization policy that defines the permissions for a principal to perform actions on several types of resources.

class DerivedRoleContext<Principal : Any, Resource : Any>(val principal: Principal, val resource: Resource)

Context for evaluating derived roles. Contains the principal and resource which are used to define the conditions under which a derived role is granted.

EvaluationContext

class EvaluationContext<Principal : Any, Resource : Any>(val principal: Principal, val resource: Resource, val derivedRoles: Set<String>)

Context for evaluating permissions. Contains the principal, resource, and derived roles which are used at runtime to determine whether the principal has permission to perform an action on the resource.

PermissionDeniedException

class PermissionDeniedException(message: String) : RuntimeException

Exception thrown when a permission check fails for a given principal and resource.

PermissionsCheck

class PermissionsCheck<Principal : Any, Resource : Any>(policy: AuthorizationPolicy<Principal>)

Internal object used by AuthorizationPolicy to enable a more fluent API for checking permissions.

ResourceAction

data class ResourceAction<Resource : Any>(val action: String)

Represents an action that can be performed on a resource. The generic type Resource is the type of resource this action can be performed on.

ResourcePolicy

class ResourcePolicy<Principal : Any, Resource : Any>

Represents a policy defining the rules for accessing a specific type of resource.

Functions

authorizationPolicy

fun <Principal : Any> authorizationPolicy(init: AuthorizationPolicy<Principal>.() -> Unit): AuthorizationPolicy<Principal>

Convenience function for creating an AuthorizationPolicy and initializing it via the provided init block.

resourcePolicy

fun <Principal : Any, Resource : Any> resourcePolicy(init: ResourcePolicy<Principal, Resource>.() -> Unit): ResourcePolicy<Principal, Resource>

Convenience function for creating a ResourcePolicy and initializing it via the provided init block.