Open Policy Agent TypeScript Packages
    Preparing search index...

    Type Alias SuccessfulPolicyResponse

    Success.

    The server also returns 200 if the path refers to an undefined document. In this case, the response will not contain a result property.

    type SuccessfulPolicyResponse = {
        decisionId?: string;
        metrics?: { [k: string]: any };
        provenance?: Provenance;
        result?: Result;
    }
    Index

    Properties

    decisionId? metrics? provenance? result?

    Properties

    decisionId?: string

    If decision logging is enabled, this field contains a string that uniquely identifies the decision. The identifier will be included in the decision log event for this decision. Callers can use the identifier for correlation purposes.

    metrics?: { [k: string]: any }

    If query metrics are enabled, this field contains query performance metrics collected during the parse, compile, and evaluation steps.

    provenance?: Provenance

    Provenance information can be requested on individual API calls and are returned inline with the API response. To obtain provenance information on an API call, specify the provenance=true query parameter when executing the API call.

    result?: Result

    The base or virtual document referred to by the URL path. If the path is undefined, this key will be omitted.

    Settings

    Member Visibility

    On This Page

    Properties