Skip to main content

Function: probeOutcome()

probeOutcome(probe): ProbeOutcome

Defined in: packages/identity/src/port.ts:819

D1.14's outcome from a probe.

  • delegated: none of realm, clients and users is available, and each was checked. delegated is a finding about the credential, so it needs the credential to have been tried.
  • automatic: every capability is available or unsupported (the provider has no such thing, so no administrator could grant it).
  • partial: anything else, so a capability is missing or indeterminate.

clients and users are indeterminate by construction while the realm does not exist yet, or when the credential was refused its lookup (ProbeResult.realmNotProbed); that alone does not stop delegated, because a credential that may not create the realm, or see it, leaves it to an administrator.

Parameters​

probe​

ProbeResult

The result of IdentityProvider.probe.

Returns​

ProbeOutcome

Throws​

unreachable (indeterminate: retry) when none of the three is available and one of them could not be checked, or was not reported. That is never collapsed into delegated.