Skip to content
aerandil.com
GitHub

Validate Enroll federated participant (dry-run)

POST
/v1/actions/hospitality.action.enroll_federated_participant/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.enroll_federated_participant/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "activate": true, "agent_installation_id": "example", "allowed_analysis_kinds": [ "federated_analytics" ], "consent_policy_reference": "example", "contribution_weight_cap": "example", "credential_reference": "example", "dpa_reference": "example", "excluded_field_classes": [ "example" ], "excluded_object_types": [ "example" ], "legal_basis_kind": "contract", "legal_basis_reference": "example", "local_execution_mode": "operator_runner", "output_access_level": "none", "participant_object_ref": "example", "participant_scope": "tenant" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_intelligence_program" } }'

Dry-run of apply_hospitality_action_enroll_federated_participant’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
activate
True to activate; false leaves status = reviewing
boolean
agent_installation_id
Required when execution mode is agent_installation
string
allowed_analysis_kinds
required
Participant-allowed analysis kinds
Array<string>
Allowed values: federated_analytics federated_learning private_set_intersection clean_room_query benchmark_export
consent_policy_reference
Required if consent is the basis
string
contribution_weight_cap
Participant-specific cap stricter than definition
string format: decimal
credential_reference
Opaque pointer; no secret material
string
dpa_reference
Required for cross-tenant programs
string
excluded_field_classes
Additional local privacy exclusions
Array<string>
excluded_object_types
Tenant-specific exclusions
Array<string>
legal_basis_kind
required
Legal basis kind
string
Allowed values: contract legitimate_interest consent public_task not_personal_data other_reviewed
legal_basis_reference
Required except not_personal_data with reviewer note
string
local_execution_mode
required
operator_runner / agent_installation / hosted_connector / third_party_clean_room
string
Allowed values: operator_runner agent_installation hosted_connector third_party_clean_room
output_access_level
required
Output-access tier
string
Allowed values: none aggregate_only participant_benchmark model_consumer
participant_object_ref
Property / venue id when scope is not tenant
string
participant_scope
required
tenant / property / portfolio / venue
string
Allowed values: tenant property portfolio venue
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.federated_intelligence_program

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}