Frodo Library - v5.0.0-17
    Preparing search index...

    Type Alias DeploymentTypeProbe

    Result of the anonymous deployment-type probe (see Authenticate.probeDeploymentType()).

    type DeploymentTypeProbe = {
        conclusive: boolean;
        deploymentType: string;
        responses: {
            idmAdminClient: { redirected: boolean; status?: number };
            idmAdminUi: { redirected: boolean; status?: number };
        };
    }
    Index
    conclusive: boolean

    True when the evidence supports deploymentType: exactly one built-in client redirected to the login (cloud or forgeops), or both clients answered 400 (an AM that has neither built-in client: classic). False when the host did not answer or answered something that is not AM-shaped (404, 403, an HTML page, a redirect elsewhere, both clients redirecting). An unreachable or mistyped host is inconclusive, not classic.

    deploymentType: string

    'cloud' | 'forgeops' | 'classic'. 'classic' is also what an inconclusive probe returns, for backward compatibility: check conclusive before trusting it.

    responses: {
        idmAdminClient: { redirected: boolean; status?: number };
        idmAdminUi: { redirected: boolean; status?: number };
    }

    The raw per-client evidence the type was derived from.

    Type Declaration

    • idmAdminClient: { redirected: boolean; status?: number }

      Probe with the cloud built-in client (idmAdminClient).

    • idmAdminUi: { redirected: boolean; status?: number }

      Probe with the ForgeOps built-in client (idm-admin-ui).