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

    Type Alias AccessProfileArea

    One area of the API and whether the session can reach it.

    type AccessProfileArea = {
        basis: AccessProfileBasis[];
        explanation?: string;
        id: AccessAreaId;
        reachable: "yes" | "partial" | "no" | "unknown";
        reason?: AccessAreaReason;
        scopes: string[];
        title: string;
        via?: "direct" | "exchange";
    }
    Index

    What the statement is based on.

    explanation?: string

    One sentence that states why, in plain words and without naming any interface of a caller.

    Stable identifier of the area.

    reachable: "yes" | "partial" | "no" | "unknown"

    yes: every scope of the area is reachable. partial: some are (for example read but not update). no: none is. unknown: the library cannot tell from what it has.

    Why the area is not (fully) reachable.

    scopes: string[]

    The scopes that the API calls of the area declare.

    title: string

    Name of the area in words.

    via?: "direct" | "exchange"

    How the area is reached: with the token as it is (direct) or through a token exchange (exchange).