Variable gateStateFor

Type Declaration

• • (
        req: any,
    ): {
        authority: string;
        available: boolean;
        bootstrap: any;
        bootstrapPasswordRequired: boolean;
        closed: boolean;
        empty: any;
        enforced: boolean;
        foreignSession: boolean;
        identityRealm: string;
        open: any;
        outsideRealm: boolean;
        read: any;
        readGroup: any;
        roles: any;
        session: any;
        sessionRealm: {
            builtin: boolean;
            createdAt: any;
            description: string;
            id: string;
            name: string;
            overrides: {};
        };
        username: any;
        windowOpens: boolean;
        windowWithheld: boolean;
        write: any;
        writeGroup: any;
    }

  • Works out the console gate's state for a request in one pass: who is signed in, which roles they hold, and whether the gate lets them in.

    Parameters

    • req: any

      the request

    Returns {
        authority: string;
        available: boolean;
        bootstrap: any;
        bootstrapPasswordRequired: boolean;
        closed: boolean;
        empty: any;
        enforced: boolean;
        foreignSession: boolean;
        identityRealm: string;
        open: any;
        outsideRealm: boolean;
        read: any;
        readGroup: any;
        roles: any;
        session: any;
        sessionRealm: {
            builtin: boolean;
            createdAt: any;
            description: string;
            id: string;
            name: string;
            overrides: {};
        };
        username: any;
        windowOpens: boolean;
        windowWithheld: boolean;
        write: any;
        writeGroup: any;
    }

    the gate's state