ExScim.Authorization (ex_scim v0.3.0)

Copy Markdown View Source

Public entry point for SCIM authorization decisions.

Delegates to the configured authorization_adapter (see ExScim.Authorization.Adapter).

When no adapter is configured, ExScim.Authorization.DefaultPolicy is used.

Summary

Functions

adapter()

Returns the configured authorization adapter module.

authorize(scope, resource, action)

Returns :ok when scope may perform action on resource, {:error, denial} otherwise.

denial_detail(arg1)

Formats a denial as a human-readable error detail.

Functions

adapter()

@spec adapter() :: module()

Returns the configured authorization adapter module.

authorize(scope, resource, action)

@spec authorize(
  ExScim.Scope.t(),
  ExScim.Authorization.Adapter.resource(),
  ExScim.Authorization.Adapter.action()
) :: :ok | {:error, ExScim.Authorization.Adapter.denial()}

Returns :ok when scope may perform action on resource, {:error, denial} otherwise.

denial_detail(arg1)

@spec denial_detail(ExScim.Authorization.Adapter.denial()) :: String.t()

Formats a denial as a human-readable error detail.