Somum.AccessControl.Requests 10.1.6

Somum.AccessControl.Requests

Somum.AccessControl.Requests is a .NET Standard 2.0 class library that defines the command and query contracts for Somum access-control resources.

It provides transport models for managing access profiles, groups, and roles. The project contains request payloads, response contracts, optional expansion flags, and route metadata; validation, authorization, persistence, and business workflows are implemented by the corresponding handler projects.

Target Framework and Dependencies

• Target framework: .NET Standard 2.0
• Project dependencies:
  • Somum.Dtos for AccessProfileDto, GroupDto, RoleDto, and permission DTOs
  • Somum.Requests for base command/query types and endpoint abstractions

Access-Control Model

The request contracts represent three related resources:

An access profile can associate existing groups and roles by identifier or create new groups and roles inline as part of the same create request.

Commands

Create an access profile

AddAccessProfileCommand creates an access profile from AddAccessProfileCommandPayload.

The payload supports two association paths:

• GroupIds and RoleIds link existing groups and roles.
• Groups and Roles create groups and roles inline, then associate the newly created resources with the profile.

The command accepts AccessProfileExpand[] through Expand to shape the creation response. Its response, AddAccessProfileCommandResponse, inherits GetAccessProfileQueryResponse so creation and retrieval use the same returned access-profile contract.

Create a group

AddGroupCommand creates a group from AddGroupCommandPayload, which contains a display Name and optional Description.

GroupExpand[] can be supplied through Expand to request optional related data in AddGroupCommandResponse.

Create a role

AddRoleCommand creates a role from AddRoleCommandPayload.

A role payload includes:

• Name — the role display name.
• Description — an optional human-readable description.
• Permissions — feature and access-level pairs represented by AddRoleCommandPayloadPermission.

GetRoleExpand[] can be supplied through Expand to request optional role data, including permissions where supported, in AddRoleCommandResponse.

Queries

The project provides single-resource and paged collection queries for each access-control resource.

Single-resource queries use an Id route parameter. Collection queries inherit filtering, sorting, and pagination options from NavigatingQuery<TResponse>.

Each query can specify the matching expand enum to request optional related data:

• AccessProfileExpand
• GroupExpand
• GetRoleExpand

Endpoints

Routing metadata is implemented in the .Routing.cs partial files. Each request exposes a ResourcePath constant and resolves the final endpoint through its overridden Endpoint property.

The API project binds these contracts to versioned HTTP endpoints, while the same contracts can be sent through the mediator layer.

Handler Behavior

This project intentionally contains no business logic. In the associated handler projects:

• Access-profile reads are permission-scoped. Super users can retrieve all profiles; other callers are filtered according to their assigned rights.
• Access-profile creation validates that provided existing group and role identifiers exist and are authorized for the current account.
• Inline group and role payloads are dispatched as create commands before their resulting identifiers are associated with the new access profile.
• Create handlers re-query newly created resources so the response honors the supplied expansion options.

Usage

Reference the project from another project in the solution:

<ItemGroup>
  <ProjectReference Include="..\Somum.AccessControl.Requests\Somum.AccessControl.Requests.csproj" />
</ItemGroup>

Create an access profile that links existing resources:

using Somum.AccessControl.Commands;

var command = new AddAccessProfileCommand
{
    Payloads = new AddAccessProfileCommandPayload
    {
        Name = "Campaign managers",
        Description = "Access profile for campaign management.",
        GroupIds = new List<long> { groupId },
        RoleIds = new List<long> { roleId }
    }
};

Contract Evolution

These models are shared API and mediator contracts. When changing them:

• Preserve route constants, public property names, and serialization attributes.
• Prefer additive, nullable properties over breaking removals or renames.
• Keep validation and authorization logic in sanitizer and handler projects.
• Update handlers, endpoint documentation, mappings, and tests when a request or response contract changes.
• Add versioned contracts when a breaking change is unavoidable.