Type Alias PendingResult

type PendingResult = {
    error?: string;
    idpClaims?: unknown;
    oauth2Error?: {
        error: string;
        errorDescription?: string;
        errorURI?: string;
    };
    protocol?: "OIDC"
    | "SAML";
    resultantClaims?: unknown;
    started?: string;
    status:
        | "success"
        | "pending"
        | "error"
        | "claimsError"
        | "callbackError"
        | "tokenError"
        | "protocolError"
        | "networkError"
        | "configChangedDuringTestError";
}
Index

Properties

error? idpClaims? oauth2Error? protocol? resultantClaims? started? status

Properties

error?: string

A unique readable error message based on the error that has occurred.

idpClaims?: unknown

The claims retrieved from the external IdP.

oauth2Error?: { error: string; errorDescription?: string; errorURI?: string }

Type declaration

  • error: string

    An error code to identity the authentication error.

  • OptionalerrorDescription?: string

    An optional human-readable description for the given error code.

  • OptionalerrorURI?: string

    An optional URI that includes additional information about the given error.

protocol?: "OIDC" | "SAML"

The protocol used to communicate with the IdP during the test flow.

resultantClaims?: unknown

The resultant claims based on the claims received from the external IdP.

started?: string

The timestamp for when the test was started for an IdP configuration. This field is only available during lifespan of the test.

status:
    | "success"
    | "pending"
    | "error"
    | "claimsError"
    | "callbackError"
    | "tokenError"
    | "protocolError"
    | "networkError"
    | "configChangedDuringTestError"

The status of the IdP configuration being tested.

Settings

Member Visibility

On This Page

Properties