Skip to main content

Interface: SetupCheckDefinition

Defined in: packages/contracts/src/setup-checks.ts:341

What the console and the engine both know about one check.

Properties​

causes​

readonly causes: readonly ("provider_unreachable" | "provider_credential_refused" | "provider_forbidden" | "provider_conflict" | "provider_rejected" | "provider_not_managed" | "provider_direct_grants_remain" | "provider_unexpected" | "provider_partial" | "provider_delegated" | "realm_missing" | "machine_client_refused" | "audience_missing" | "test_recipient_refused" | "mail_settings_invalid" | "secret_unreadable" | "root_account_not_declared" | "root_account_not_created" | "invitation_failed" | "invitation_unconfirmed" | "answers_invalid" | "governing_account_missing" | "governing_account_is_root" | "anchor_facts_missing" | "framework_missing" | "framework_invalid" | "service_no_reply" | "service_denied" | "service_refused" | "service_failed" | "reply_incomplete" | "authority_not_file" | "configuration_not_stored" | "audit_not_acknowledged" | "store_failed" | "module_token_missing" | "module_not_permitted" | "module_identification_missing" | "module_unavailable" | "module_session_lost" | "test_key_failed" | "test_key_not_destroyed" | "federation_not_verified" | "federation_unchecked" | "identifier_not_found" | "identifier_unverifiable" | "identifier_deactivated" | "identifier_parallel_differs" | "identifier_parallel_absent" | "root_account_not_linked" | "unexpected")[]

Defined in: packages/contracts/src/setup-checks.ts:354

Every cause this check can carry. The engine reports nothing outside this list (a cause it would otherwise report becomes unexpected), so the string table can be complete: one sentence per pair of check and cause listed here.

reportsApply​

readonly reportsApply: boolean

Defined in: packages/contracts/src/setup-checks.ts:348

Whether it reports on the step's own write. Such a check is not run under plan mode; see SETUP_CHECK_IDS.

step​

readonly step: "anchor" | "identifiers" | "organizations" | "identity-provider" | "accounts" | "key-store" | "configuration"

Defined in: packages/contracts/src/setup-checks.ts:343

The step it belongs to.