API by area

Audit log

45 endpoints. Paths are relative to https://api.sandscale.dev; values in braces are ones you fill in.

API reference · Authentication · Errors

MethodPathWhat it does
GET/api/v1/account/audit-logs(Brief H item 2): the entries the signed-in person caused in their organization, with no audit:read. The organization is the caller's own and the actor is always the caller; the query takes the same filters as GET /api/v1/audit-logs. An API key or a delegated or workspace token has no account of its own: 403 person_required.
GET/api/v1/audit-logsList audit logs
GET/api/v1/audit-logs/chain-lanesReturns the caller's organization's audit chain lane count: in effect, and the requested one the next epoch seal applies.
PUT/api/v1/audit-logs/chain-lanesRequests a lane count for the caller's organization's audit chain (1 is one strict total order, up to 64): an Owner or Admin action, audited in the transaction that records it, applied by the next epoch seal (202).
GET/api/v1/audit-logs/cold-segmentsThe organization's objects of sealed segments, oldest first, with their segment's manifest digest and signing key, and the bundle to download for offline verification.
GET/api/v1/audit-logs/cold-segments/{seq}/bundleA tar of the segment's manifest, its signature, its spine and the organization's object, laid out as in the bucket, each checked against the recorded manifest before it is sent. The download is audited first: one whose audit entry cannot be written does not happen.
GET/api/v1/audit-logs/endpoint-activityThe entries enrolled endpoint agents uploaded, by category (awareness, staging or tamper), optionally for one device, newest first, within the plan's read window. Sandscale decides which entries belong to a category.
POST/api/v1/audit-logs/exportQueues an export of the caller's organization's audit log:
GET/api/v1/audit-logs/exportsList exports
GET/api/v1/audit-logs/exports/{exportID}Get one export
GET/api/v1/audit-logs/exports/{exportID}/downloadDownload of an export
POST/api/v1/audit-logs/merkle/checkpointSeals the caller's organization's audit chain since its last checkpoint into a signed Merkle checkpoint (audit:create). At most one a minute (429 checkpoint_too_soon); 409 no_new_entries when nothing was written since the last one.
GET/api/v1/audit-logs/merkle/checkpointsLists the caller's organization's checkpoints, newest first (audit:read).
GET/api/v1/audit-logs/merkle/checkpoints/{seq}/verifyRe-checks one of the caller's organization's checkpoints (audit:read): the signature against the published key, the link to the previous checkpoint, and the count and root recomputed from the audit log (PostgreSQL, then the audit archive).
GET/api/v1/audit-logs/organizationThe Organization trail, the entries of every account of the caller's Organization. The database decides who may read it: the management account, or the account registered as delegated administrator of audit.neuralinverse.io, while trusted access for audit.neuralinverse.io is enabled; anyone else gets 403 with the reason code (trusted_access_disabled, not_management_or_delegated_admin, no_organization). Every read, refused ones included, is audited in the caller's account (audit.organization_trail.read).
GET/api/v1/audit-logs/queryThe query over the organization's entries in [from, to), hot and cold tiers alike, within the plan's read window.
GET/api/v1/audit-logs/retentionAnswers the caller's organization's audit retention policy in force (version 0 is the default of an organization that never set one) and its last versions.
PUT/api/v1/audit-logs/retentionWrites the next version of the caller's organization's audit retention policy: {"expected_version", "default_days", "by_regulation", "reason"}. The route is re-verified. Shortening or removing a period also needs a person and a reason of at least 10 characters, and is refused while a legal hold covers entries the shorter period would no longer keep.
GET/api/v1/audit-logs/sessionsList sessions
GET/api/v1/audit-logs/sessions/{id}/replayReplay of a session
GET/api/v1/audit-logs/storage-statsReports where the caller's organization's audit log is stored (every organization's, with the table size, for a super admin): the hot and cold PostgreSQL rows, and, with audit tiering, the entries moved to the audit bucket (object_storage).
GET/api/v1/audit-logs/streamList stream
GET/api/v1/audit-logs/tieringThe organization's hot window and archive retention (from its entitlements), what it has in the cold tier and what is sealed but still hot. A super admin without organization_id sees the platform: every organization's cold tier and the latest runs.
GET/api/v1/audit-logs/verificationsList verifications
POST/api/v1/audit-logs/verificationsCreate a verification
GET/api/v1/audit-logs/verifications/{id}Get one verification
GET/api/v1/audit-logs/verifyList verify
POST/api/v1/audit/client-eventsRecords the actions a signed-in person took in a first-party app in the audit ledger. The route needs api:access; the handler then admits only a person's access token issued to a registered first-party OAuth client. The organization and user are the token's: the body may repeat them but a body naming any other is refused (403 not_own_identity) before anything is recorded.
GET/api/v1/audit/packsList packs
POST/api/v1/audit/packsCreate a pack
GET/api/v1/audit/packs/{id}Get one pack
GET/api/v1/audit/packs/{id}/evidenceEvidence of a pack
GET/api/v1/audit/packs/{id}/exportExport of a pack
POST/api/v1/audit/signing-keys/rotateCreate a rotate
GET/api/v1/audit/streamsList streams
POST/api/v1/audit/streamsCreate a stream
GET/api/v1/audit/streams/{id}Get one stream
PATCH/api/v1/audit/streams/{id}Update one stream
DELETE/api/v1/audit/streams/{id}Delete one stream
PUT/api/v1/audit/streams/{id}/piiSet the pii of a stream
POST/api/v1/audit/streams/{id}/resumeResume a stream
GET/api/v1/audit/streams/{id}/setupAnswers a kind's walkthrough (?kind=) or a destination's ({id}), with the Sandscale values the provider needs: for S3 the principal ARN Sandscale assumes roles as, the destination's external ID and its trust and permission policies. Nothing secret is in it.
GET/api/v1/audit/streams/{id}/statusStatus of a stream
POST/api/v1/audit/streams/{id}/testTest a stream
GET/api/v1/audit/streams/setupAnswers a kind's walkthrough (?kind=) or a destination's ({id}), with the Sandscale values the provider needs: for S3 the principal ARN Sandscale assumes roles as, the destination's external ID and its trust and permission policies. Nothing secret is in it.

Endpoints

GET /api/v1/account/audit-logs

(Brief H item 2): the entries the signed-in person caused in their organization, with no audit:read. The organization is the caller's own and the actor is always the caller; the query takes the same filters as GET /api/v1/audit-logs. An API key or a delegated or workspace token has no account of its own: 403 person_required.

Permission
signed in
Query parameters
action, action_prefix, from, include_read_only, outcome, project_activity, project_id, resource_type, to
Errors
400: invalid_query; 401: unauthorized; 403: forbidden, person_required; 404: not_found; 503: unavailable

GET /api/v1/audit-logs

List audit logs

Permission
audit:read
Query parameters
action, action_prefix, from, include_read_only, outcome, project_activity, project_id, resource_type, to
Errors
400: invalid_query; 403: forbidden; 404: not_found; 503: unavailable

GET /api/v1/audit-logs/chain-lanes

Returns the caller's organization's audit chain lane count: in effect, and the requested one the next epoch seal applies.

Permission
audit:read
Response
200: object of any
Errors
403: forbidden

PUT /api/v1/audit-logs/chain-lanes

Requests a lane count for the caller's organization's audit chain (1 is one strict total order, up to 64): an Owner or Admin action, audited in the transaction that records it, applied by the next epoch seal (202).

Permission
audit.chain:configure
Request body
object
Response
202: object of any
Errors
400: invalid_body, validation_error; 403: forbidden

GET /api/v1/audit-logs/cold-segments

The organization's objects of sealed segments, oldest first, with their segment's manifest digest and signing key, and the bundle to download for offline verification.

Permission
audit:read
Query parameters
organization_id
Response
200: object of any
Errors
403: forbidden; 503: tiering_unavailable

GET /api/v1/audit-logs/cold-segments/{seq}/bundle

A tar of the segment's manifest, its signature, its spine and the organization's object, laid out as in the bucket, each checked against the recorded manifest before it is sent. The download is audited first: one whose audit entry cannot be written does not happen.

Permission
audit:read
Path parameters
seq
Query parameters
organization_id
Errors
403: forbidden; 404: not_found; 409: cold_tier_integrity; 502: bucket_unavailable; 503: tiering_unavailable

GET /api/v1/audit-logs/endpoint-activity

The entries enrolled endpoint agents uploaded, by category (awareness, staging or tamper), optionally for one device, newest first, within the plan's read window. Sandscale decides which entries belong to a category.

Permission
audit:read
Query parameters
category, device_id
Response
200: object of any
Errors
400: invalid_query; 403: forbidden

POST /api/v1/audit-logs/export

Queues an export of the caller's organization's audit log:

Permission
audit:create
Request body
object
Response
202: object of any
Errors
400: invalid_body, validation_error; 403: forbidden; 404: not_found; 503: export_unavailable, unavailable

GET /api/v1/audit-logs/exports

List exports

Permission
audit:read
Response
200: object of any
Errors
403: forbidden; 503: export_unavailable

GET /api/v1/audit-logs/exports/{exportID}

Get one export

Permission
audit:read
Path parameters
exportID
Response
200: object of any
Errors
403: forbidden; 404: not_found; 503: export_unavailable

GET /api/v1/audit-logs/exports/{exportID}/download

Download of an export

Permission
audit:read
Path parameters
exportID
Errors
403: forbidden; 404: not_found; 409: export_integrity, export_not_ready; 410: export_expired; 503: export_unavailable

POST /api/v1/audit-logs/merkle/checkpoint

Seals the caller's organization's audit chain since its last checkpoint into a signed Merkle checkpoint (audit:create). At most one a minute (429 checkpoint_too_soon); 409 no_new_entries when nothing was written since the last one.

Permission
audit:create
Response
201: object of any
Errors
400: organization_required; 403: forbidden; 409: no_new_entries; 429: checkpoint_too_soon; 503: checkpoints_unavailable

GET /api/v1/audit-logs/merkle/checkpoints

Lists the caller's organization's checkpoints, newest first (audit:read).

Permission
audit:read
Response
200: object of any
Errors
400: organization_required; 503: checkpoints_unavailable

GET /api/v1/audit-logs/merkle/checkpoints/{seq}/verify

Re-checks one of the caller's organization's checkpoints (audit:read): the signature against the published key, the link to the previous checkpoint, and the count and root recomputed from the audit log (PostgreSQL, then the audit archive).

Permission
audit:read
Path parameters
seq
Response
200: Verification
Errors
400: organization_required; 404: not_found; 503: checkpoints_unavailable

GET /api/v1/audit-logs/organization

The Organization trail, the entries of every account of the caller's Organization. The database decides who may read it: the management account, or the account registered as delegated administrator of audit.neuralinverse.io, while trusted access for audit.neuralinverse.io is enabled; anyone else gets 403 with the reason code (trusted_access_disabled, not_management_or_delegated_admin, no_organization). Every read, refused ones included, is audited in the caller's account (audit.organization_trail.read).

Permission
audit:read
Query parameters
account, action, action_prefix, include_read_only, outcome, resource_type
Response
200: object of any
Errors
400: invalid_query; 403: forbidden

GET /api/v1/audit-logs/query

The query over the organization's entries in [from, to), hot and cold tiers alike, within the plan's read window.

Permission
audit:read
Query parameters
from, organization_id, project_activity, query, to
Response
200: object of any
Errors
400: invalid_query, validation_error; 403: forbidden; 409: cold_tier_integrity; 422: query_too_wide; 429: query_busy; 503: tiering_unavailable

GET /api/v1/audit-logs/retention

Answers the caller's organization's audit retention policy in force (version 0 is the default of an organization that never set one) and its last versions.

Permission
audit:read
Response
200: object of any
Errors
400: organization_required; 503: retention_unavailable

PUT /api/v1/audit-logs/retention

Writes the next version of the caller's organization's audit retention policy: {"expected_version", "default_days", "by_regulation", "reason"}. The route is re-verified. Shortening or removing a period also needs a person and a reason of at least 10 characters, and is refused while a legal hold covers entries the shorter period would no longer keep.

Permission
audit:update
Request body
object
Response
200: object of any
Errors
400: invalid_body, organization_required, reason_required, validation_error; 403: elevation_required, person_required; 409: legal_hold_active, version_conflict; 503: retention_unavailable

GET /api/v1/audit-logs/sessions

List sessions

Permission
audit:read
Response
200: object of any
Errors
403: forbidden

GET /api/v1/audit-logs/sessions/{id}/replay

Replay of a session

Permission
audit:read
Path parameters
id
Response
200: object of any
Errors
403: forbidden

GET /api/v1/audit-logs/storage-stats

Reports where the caller's organization's audit log is stored (every organization's, with the table size, for a super admin): the hot and cold PostgreSQL rows, and, with audit tiering, the entries moved to the audit bucket (object_storage).

Permission
audit:read
Response
200: object of any
Errors
403: forbidden

GET /api/v1/audit-logs/stream

List stream

Permission
audit:read
Errors
400: invalid_query; 401: unauthorized

GET /api/v1/audit-logs/tiering

The organization's hot window and archive retention (from its entitlements), what it has in the cold tier and what is sealed but still hot. A super admin without organization_id sees the platform: every organization's cold tier and the latest runs.

Permission
audit:read
Query parameters
organization_id
Response
200: object of any
Errors
403: forbidden; 503: tiering_unavailable

GET /api/v1/audit-logs/verifications

List verifications

Permission
audit:read
Query parameters
limit
Response
200: object of any
Errors
403: forbidden; 503: unavailable

POST /api/v1/audit-logs/verifications

Create a verification

Permission
audit:read
Request body
object
Response
202: Job
Errors
400: invalid_json, validation_error; 403: forbidden; 415: content_type; 503: unavailable

GET /api/v1/audit-logs/verifications/{id}

Get one verification

Permission
audit:read
Path parameters
id
Response
200: Job
Errors
403: forbidden; 404: not_found; 503: unavailable

GET /api/v1/audit-logs/verify

List verify

Permission
audit:read
Query parameters
from, to
Response
200: Result
Errors
400: validation_error; 403: forbidden; 422: range_too_large; 503: unavailable

POST /api/v1/audit/client-events

Records the actions a signed-in person took in a first-party app in the audit ledger. The route needs api:access; the handler then admits only a person's access token issued to a registered first-party OAuth client. The organization and user are the token's: the body may repeat them but a body naming any other is refused (403 not_own_identity) before anything is recorded.

Permission
api:access
Response
200: object
Errors
400: invalid_request; 401: unauthorized; 403: api_key_not_allowed, client_not_first_party, not_own_identity; 413: batch_too_large, payload_too_large; 415: content_type; 503: dlp_unavailable

GET /api/v1/audit/packs

List packs

Permission
audit:read
Query parameters
framework
Response
200: object of any
Errors
401: unauthorized

POST /api/v1/audit/packs

Create a pack

Permission
audit:create
Request body
object
Response
201: EvidencePack
Errors
400: invalid_json, validation_error; 401: unauthorized; 415: content_type

GET /api/v1/audit/packs/{id}

Get one pack

Permission
audit:read
Path parameters
id
Response
200: EvidencePack
Errors
400: validation_error; 401: unauthorized; 404: not_found

GET /api/v1/audit/packs/{id}/evidence

Evidence of a pack

Permission
audit:read
Path parameters
id
Response
200: object of any
Errors
400: validation_error; 401: unauthorized

GET /api/v1/audit/packs/{id}/export

Export of a pack

Permission
audit:read
Path parameters
id
Errors
400: validation_error; 401: unauthorized; 404: not_found

POST /api/v1/audit/signing-keys/rotate

Create a rotate

Permission
audit:update
Response
200: object of any
Errors
403: forbidden

GET /api/v1/audit/streams

List streams

Permission
audit:read
Response
200: object of any
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

POST /api/v1/audit/streams

Create a stream

Permission
audit:admin
Request body
auditStreamBody
Response
201: Destination
Errors
400: invalid_json, validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 415: content_type; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

GET /api/v1/audit/streams/{id}

Get one stream

Permission
audit:read
Path parameters
id
Response
200: Destination
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

PATCH /api/v1/audit/streams/{id}

Update one stream

Permission
audit:admin
Path parameters
id
Request body
auditStreamBody
Response
200: Destination
Errors
400: invalid_json, validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 415: content_type; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

DELETE /api/v1/audit/streams/{id}

Delete one stream

Permission
audit:admin
Path parameters
id
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

PUT /api/v1/audit/streams/{id}/pii

Set the pii of a stream

Permission
audit:admin
Path parameters
id
Request body
object
Response
200: Destination
Errors
400: invalid_json, validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 415: content_type; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

POST /api/v1/audit/streams/{id}/resume

Resume a stream

Permission
audit:admin
Path parameters
id
Response
200: Destination
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

GET /api/v1/audit/streams/{id}/setup

Answers a kind's walkthrough (?kind=) or a destination's ({id}), with the Sandscale values the provider needs: for S3 the principal ARN Sandscale assumes roles as, the destination's external ID and its trust and permission policies. Nothing secret is in it.

Permission
audit:read
Path parameters
id
Query parameters
kind
Response
200: Setup
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

GET /api/v1/audit/streams/{id}/status

Status of a stream

Permission
audit:read
Path parameters
id
Response
200: Status
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

POST /api/v1/audit/streams/{id}/test

Test a stream

Permission
audit:admin
Path parameters
id
Response
200: TestResult
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

GET /api/v1/audit/streams/setup

Answers a kind's walkthrough (?kind=) or a destination's ({id}), with the Sandscale values the provider needs: for S3 the principal ARN Sandscale assumes roles as, the destination's external ID and its trust and permission policies. Nothing secret is in it.

Permission
audit:read
Query parameters
kind
Response
200: Setup
Errors
400: validation_error; 401: unauthorized; 404: not_found; 409: conflict, destination_unreadable, limit_reached; 422: egress_refused; 429: rate_limited; 503: audit_unavailable, credential_store_unavailable

Objects

object

FieldTypeDescription
formatstring
fromstring
tostring
actionstring
action_prefix optionalstring
resource_typestring
outcomestring
project_idstring

object

FieldTypeDescription
fromstring
tostring

object

FieldTypeDescription
frameworkstring
period_startstring
period_endstring

object

FieldTypeDescription
lanes optionalinteger

object

FieldTypeDescription
expected_version optionalinteger
default_days optionalinteger
by_regulationobject of integer
reasonstring

object

FieldTypeDescription
include_pii optionalboolean

object

FieldTypeDescription
resultsarray of Result
acceptedinteger
duplicatesinteger
rejectedinteger
clientv1.clientSource

EvidencePack

A container for a set of evidence items covering a compliance framework within a reporting period.

FieldTypeDescription
IDstring
OrgIDstring
Frameworkstring
PeriodStarttimestamp
PeriodEndtimestamp
Statusstring
EvidenceCountinteger
GeneratedAttimestamp
Summaryobject of any

Credential

Credential describes a destination's stored credential, never its value.

FieldTypeDescription
configuredboolean
fieldsarray of string
versioninteger
updated_at optionaltimestamp

Destination

An organization's audit stream destination as the API returns it.

FieldTypeDescription
idstring
namestring
kindstring
formatstring
enabledboolean
statestring
state_reasonstring
state_changed_attimestamp
include_piiboolean
settingsobject of string
credentialCredential
filtersFilters
filters_changed_attimestampWhen the filters last changed (zero: never since creation).
created_attimestamp
created_by optionalstring
updated_attimestamp
updated_by optionalstring
row_error optionalstringRowError says why the stored row cannot be used (settings or filters that do not decode). Such a destination is never delivered to; delete it and create it again.

Filters

Filters choose the entries a destination receives. Entries a filter leaves out still move the cursor: the destination asked not to receive them.

FieldTypeDescription
action_prefixes optionalarray of string
exclude_action_prefixes optionalarray of string
min_severity optionalinteger

LaneStatus

A destination's position in one lane.

FieldTypeDescription
lane_keystring
delivered_seqinteger
head_seqinteger
lag_entriesinteger
lag_secondsinteger
stopped_reason optionalstring
stopped_at optionaltimestamp

Setup

FieldTypeDescription
kindstring
destination_id optionalstringSet for a destination's walkthrough.
principal_arn optionalstringThe AWS identity Sandscale assumes roles as, when the operator configured it.
guideGuide

Status

A destination's delivery status.

FieldTypeDescription
destination_idstring
statestring
state_reasonstring
enabledboolean
delivered_totalinteger
failed_totalinteger
consecutive_failuresinteger
last_attempt_at optionaltimestamp
last_success_at optionaltimestamp
last_error_at optionaltimestamp
last_error_class optionalstring
next_attempt_at optionaltimestamp
lag_entriesinteger
lag_secondsinteger
lanesarray of LaneStatus

TestResult

The outcome of a connection test.

FieldTypeDescription
okboolean
error_class optionalstring
message optionalstring
tested_attimestamp
code optionalstringThe stable code of the failure: the error class, or the stage code assume_role_denied or sign_in_refused. The kind's walkthrough has its fix.
resultResultThe test as staged checks.

Break

The first entry whose signature or link does not hold.

FieldTypeDescription
idinteger
attimestamp
reasonstring

CheckpointView

The last signed checkpoint at or before the range's end.

FieldTypeDescription
checkpoint_idstring
end_event_idstring
end_timestamptimestamp
key_idstring
signature_validboolean

Explanation

A verification's result in plain words. Sandscale writes it; the console shows it as it is.

FieldTypeDescription
statusstringExplanationIntact, ExplanationBroken or ExplanationCheckpointInvalid.
labelstringThe result in two or three words.
summarystringWhat was checked and what was found.
break_reason optionalstringBreakReason says why the first break is a break and what it can mean; empty without one.
detailsarray of stringFurther facts of the run, one sentence each.

FormUse

FormUse counts the entries of a verification that verified in one earlier signed form.

FieldTypeDescription
formstring
descriptionstring
entriesinteger
first_idinteger
last_idinteger

Job

A verification run as a job.

FieldTypeDescription
idstring
org_idstring
requested_by optionalstring
statusstring
error optionalstring
resultResult
created_attimestamp
started_at optionaltimestamp
completed_at optionaltimestamp
expires_attimestamp
currency optionalstringCurrency says whether a completed result is the one to read: CurrencyCurrent, or CurrencySuperseded when a newer passing run of the same chain covers its range. Derived when the job is read, never stored; empty until the job completes.
superseded_by optionalSupersederSupersededBy names the newer passing run, set with CurrencySuperseded. The older row stays exactly as it was written (append-only): it is the record of what that run found.

RangeView

The range with the first and last entry checked.

FieldTypeDescription
fromtimestamp
totimestamp
first_id optionalinteger
last_id optionalinteger

Result

FieldTypeDescription
verifiedinteger
first_break optionalBreak
rangeRangeView
checkpoint optionalCheckpointView
cold_linksinteger
write_time_formsarray of FormUseThe entries that verified in an earlier signed form: an earlier server version signed their metadata in another key order than the ledger stores it in. They verify; the result says so.
explanation optionalExplanationThe result in plain words, derived from the fields above whenever a result is returned (never stored); nil while a job has not completed.

Superseder

The newer passing run that supersedes an older failing one.

FieldTypeDescription
idstring
completed_attimestamp
verifiedintegerThe number of entries the newer run verified.
notestringNote says in plain words why the older result is superseded and what is kept.

Problem

Problem says why an event was rejected.

FieldTypeDescription
codestring
messagestring

Result

The outcome of one event of a batch, in request order.

FieldTypeDescription
indexinteger
client_event_id optionalstring
statusstring"accepted" (recorded now), "duplicate" (recorded by an earlier request or an earlier event of this one) or "rejected".
id optionalstringThe audit entry's id, the same for an event and every retry of it.
duplicateboolean
recorded_at optionaltimestamp
error optionalProblem

Verification

The verifier's answer.

FieldTypeDescription
seqinteger
validboolean
signature_validboolean
post_quantumboolean
key_idstring
key_statusstring
merkle_root_matchesboolean
recomputed_event_countinteger
event_count_matchesboolean
entries_validbooleanEntriesValid: every sealed entry's hash is the signature of its stored content, each entry links to its predecessor in the lane by previous_hash, and each lane's first and last entry are the ids the checkpoint names.
previous_linkedbooleanPreviousLinked: the checkpoint names the hash of the previous checkpoint's payload (or is the first).
contiguousbooleanContiguous: every lane goes on where the previous checkpoint ended it (from_seq is the previous to_seq + 1) and no lane the previous checkpoint named is missing. Always true for the first checkpoint.
from_archiveintegerHow many leaves were read from the audit archive.
reasonsarray of string

Check

One staged check of a test.

FieldTypeDescription
KeystringStable ("connect", "bind", "search_base").
Labelstring
StatestringStatePassed, StateFailed, StateWaiting or StateSkipped (an earlier check failed, or the check does not apply).
Code optionalstringCode names the Problem of a failed or waiting check.
Detail optionalstringSandscale's own wording of what it found, never a provider's raw error text.

Field

One provider value to paste back into a Sandscale form field.

FieldTypeDescription
NamestringThe Sandscale field it fills (the API's JSON name).
LabelstringThe Sandscale form's label.
ProviderLabelstringWhat the provider calls it ("Application (client) ID").

Guide

One integration variant's walkthrough.

FieldTypeDescription
IntegrationstringIntegration names the integration ("scim", "social", "ldap", "dns", "sso").
Variant optionalstringThe provider or preset ("entra_id", "okta", "active_directory").
Titlestring
ProviderUi optionalstringProviderUI names the console the click paths are in ("Microsoft Entra admin center").
ReviewedAtstringThe date (YYYY-MM-DD) the click paths were last checked against the provider's console and documentation.
Stepsarray of Step
Valuesobject of stringThe Sandscale values the steps name, by source: only real values of the caller's configuration, absolute URLs. A source with no value yet is absent.
Notes optionalarray of Note
Verify optionalVerify
Problems optionalarray of Problem
DocsPath optionalstringThe generated public page, relative to the repository.

Note

A notice next to the steps.

FieldTypeDescription
Titlestring
Textstring
Tone optionalstring"info" (empty) or "warning".

Problem

One troubleshooting entry; a test result or the provider names it by Code.

FieldTypeDescription
Codestring
Titlestring
Causestring
Fixstring
Settings optionalarray of stringThe provider settings to change, in order.

Result

The one answer of every integration's test, so one console component renders them all: the overall state, the code of the first failing check (a Problem of the guide names the fix), Sandscale's own message and the staged checks in the order they ran.

FieldTypeDescription
StatestringStatePassed, StateFailed or StateWaiting (nothing to fail yet, such as a SCIM token no identity provider has used).
Code optionalstring
Messagestring
Checksarray of Check
TestedAttimestampWhen Sandscale ran the checks.

Step

One step of a walkthrough.

FieldTypeDescription
KeystringStable within the guide ("register_app", "provisioning").
Where optionalstring
WizardStep optionalstringWizard names the Identity Center wizard step the step belongs to.
Titlestring
ClickPath optionalarray of stringThe path through the provider's console, one item per click.
Values optionalarray of ValueWhat to enter at the provider.
PasteBack optionalarray of FieldThe provider's values to bring back into Sandscale.
TextstringText says what to do there.

Value

One value to enter at the provider: Source names a Sandscale value of Guide.Values (the console shows it with a copy button), Literal is a fixed value.

FieldTypeDescription
Labelstring
Source optionalstring
Literal optionalstring
Format optionalstringFormatText (empty), FormatCommand or FormatJSON.
Secret optionalbooleanSecret: the value is shown once, when Sandscale issues it (a token); it is never in Guide.Values afterwards.

Verify

Verify says how the administrator proves the connection works.

FieldTypeDescription
ActionstringWhat the console offers: "TEST_CONNECTION", "WAIT_FOR_FIRST_REQUEST", "SIGN_IN", "CHECK_DNS".
Labelstring
TextstringText says what success looks like.

auditStreamBody

A create or update body. OrgID and OrganizationID are accepted and ignored: the organization is the caller's. IncludePII is refused here: it has its own route.

FieldTypeDescription
name optionalstring
kind optionalstring
format optionalstring
enabled optionalboolean
settingsobject of string
credentialsobject of string
filters optionalFilters
include_pii optionalboolean
org_id optionalstring
organization_id optionalstring

clientSource

What the request's client was recorded as: the verified OAuth client id of the token, and the declared name and version ("" when absent or malformed).

FieldTypeDescription
idstring
name optionalstring
version optionalstring

This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.