Variable sessionPrincipal

Type Declaration

• • (
        username: any,
        via?: any,
        opts?: any,
    ): {
        admin: boolean;
        hasEntry: boolean;
        id: string;
        kind: string;
        realm: any;
        via: any;
    }

  • Builds a principal for a console, API or portal session that authenticated elsewhere.

    Parameters

    • username: any

      the person

    • Optionalvia: any

      the door

    • Optionalopts: any

      admin: true or false to decide, else the ambient realm's roster decides

    Returns {
        admin: boolean;
        hasEntry: boolean;
        id: string;
        kind: string;
        realm: any;
        via: any;
    }

    the principal: kind, id, admin, via, realm and whether an entry exists