Class GovernedOperationsController
- Namespace
- ReferenceApplication.Web.Controllers.Api
- Assembly
- ReferenceApplication.Web.dll
Demonstrates host-owned governance enforcement on authenticated application operations.
[ApiController]
[ApiVersion("1.0")]
[Authorize(Policy = "application.AuthenticatedUser")]
[Route("api/v{version:apiVersion}/governed-operations")]
public sealed class GovernedOperationsController : ControllerBase
- Inheritance
-
GovernedOperationsController
- Inherited Members
Methods
CreateRecord(CreateGovernedRecordRequest, IApplicationAuditedTransaction, IApplicationAuditCompletionOutbox, IGovernanceDecisionEvidenceAccessor, GovernanceEvidenceNotificationPublisher, CancellationToken)
Creates a sample application record as an administrator-governed, audited mutation (walkthrough Step 6).
[HttpPost("records")]
[ValidateAntiForgeryToken]
[EmitGovernanceAudit]
[GovernancePolicy(typeof(AdministratorActionPolicy))]
[ProducesResponseType<GovernedRecordCreatedResponse>(201)]
public Task<ActionResult<GovernedRecordCreatedResponse>> CreateRecord(CreateGovernedRecordRequest request, IApplicationAuditedTransaction auditedTransaction, IApplicationAuditCompletionOutbox completionOutbox, IGovernanceDecisionEvidenceAccessor evidenceAccessor, GovernanceEvidenceNotificationPublisher notificationPublisher, CancellationToken cancellationToken)
Parameters
requestCreateGovernedRecordRequestThe record to create.
auditedTransactionIApplicationAuditedTransactionThe NCAT audited transaction coordinator.
completionOutboxIApplicationAuditCompletionOutboxThe NCAT audit-completion outbox.
evidenceAccessorIGovernanceDecisionEvidenceAccessorThe governance decision evidence persisted for this request.
notificationPublisherGovernanceEvidenceNotificationPublisherThe isolated best-effort evidence notification publisher.
cancellationTokenCancellationTokenA token that cancels the request.
Returns
- Task<ActionResult<GovernedRecordCreatedResponse>>
The created record and the identifiers that link it to its governance decision.
Remarks
Endpoint governance persists the decision receipt to the AsiBackbone audit ledger before this action runs. The mutation then runs inside NCAT's audited transaction, so its mutation-audit records carry the ledger record identifier, and the same transaction stages an audit-completion outbox entry. The outbox later delivers that entry to AsiBackboneAuditCompletionPublisher, which appends the matching AsiBackbone lifecycle event.
ExecuteAdministratorAction()
Executes a sample operation only for an actor in a configured administrator role.
[HttpPost("administrator")]
[ValidateAntiForgeryToken]
[EmitGovernanceAudit]
[GovernancePolicy(typeof(AdministratorActionPolicy))]
public ActionResult<GovernedOperationResponse> ExecuteAdministratorAction()
Returns
- ActionResult<GovernedOperationResponse>
A response confirming that the governed action executed.
ExecuteCapabilityAction()
Executes a sample operation only when the actor holds the declared endpoint capability.
[HttpPost("capability")]
[ValidateAntiForgeryToken]
[EmitGovernanceAudit]
[GovernancePolicy(typeof(CapabilityProtectedActionPolicy))]
[RequireCapabilityGrant("referenceapplication.consequential.execute")]
public ActionResult<GovernedOperationResponse> ExecuteCapabilityAction()
Returns
- ActionResult<GovernedOperationResponse>
A response confirming that the governed action executed.
ExecuteConsequentialAction(ApplicationAcknowledgmentWorkflow, CancellationToken)
Requests a sample consequential operation that requires administrator role, capability grant, and explicit acknowledgment before execution.
[HttpPost("consequential")]
[ValidateAntiForgeryToken]
[EmitGovernanceAudit]
[GovernancePolicy(typeof(AdministratorActionPolicy))]
[GovernancePolicy(typeof(CapabilityProtectedActionPolicy))]
[GovernancePolicy(typeof(ConsequentialActionPolicy))]
[RequireCapabilityGrant("referenceapplication.consequential.execute")]
[RequireAcknowledgment]
public Task<ActionResult<GovernedOperationResponse>> ExecuteConsequentialAction(ApplicationAcknowledgmentWorkflow acknowledgmentWorkflow, CancellationToken cancellationToken)
Parameters
acknowledgmentWorkflowApplicationAcknowledgmentWorkflowcancellationTokenCancellationToken
Returns
- Task<ActionResult<GovernedOperationResponse>>
An acknowledgment challenge; the action body does not run until a later host flow handles it.
Get()
Describes the sample operations without performing a consequential action.
[HttpGet]
[AllowAnonymous]
public ActionResult<GovernedOperationResponse> Get()
Returns
- ActionResult<GovernedOperationResponse>
A description of the endpoint-governance sample.
Remarks
This read-only endpoint is intentionally anonymous and carries no AsiBackbone governance metadata.