Variable usersJson

Type Declaration

• • (
        req: any,
        risk?: any,
    ):
        | {
            authenticatedHere: number;
            capped: boolean;
            factors: {
                noCredential: number;
                passwordOnly: number;
                primaryKeys: number;
                unreadable: number;
                withKeys: number;
                withSecond: number;
                withTotp: number;
            };
            filter: { factor: string; protocol: string; q: string };
            firstRow: number;
            known: number;
            lastRow: number;
            matched: number;
            page: number;
            pages: number;
            perPage: number;
            protocols: string[];
            registryCap: number;
            scanLimit: number;
            scanned: number;
            shown: any;
            store: boolean;
            users: any;
        }
        | { known: boolean } & {
            artifacts: any;
            artifactsPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            attributeEditor: {
                attributes: (
                    EditableRow & { editable: boolean; values: string[]; why: string }
                )[];
                dn: string;
                mail: string;
                withheld: Withheld[];
            };
            credentials: any;
            factors: {
                activated: boolean;
                appPasswords: any;
                backupCodes: | {
                    generatedAt: number;
                    hashed?: undefined;
                    lastUsedAt: number;
                    legacy?: undefined;
                    present: boolean;
                    remaining: number;
                    sealed: boolean;
                    total: number;
                    usable: boolean;
                    used: number;
                    why: string;
                }
                | {
                    generatedAt: number;
                    hashed: boolean;
                    lastUsedAt: number;
                    legacy: boolean;
                    present: boolean;
                    remaining: number;
                    sealed: boolean;
                    total: number;
                    usable: boolean;
                    used: number;
                    why: string;
                };
                disabled: boolean;
                keys: {
                    aaguid: any;
                    algorithm: {
                        coseAlg: number;
                        insecure: boolean;
                        name: string;
                        postQuantum: boolean;
                        text: string;
                    };
                    attestation: any;
                    credentialId: any;
                    enrolledAt: any;
                    label: any;
                    role: any;
                    signCount: any;
                }[];
                mfaKeys: number;
                mfaRequired: boolean;
                mfaRequirement: | {
                    byAdministrator: boolean;
                    byRealm: boolean;
                    byUser: boolean;
                    offered: boolean;
                    required: boolean;
                }
                | { byRealm: false; byUser: false; required: false };
                password: boolean;
                passwordChangeRequired: boolean;
                passwordOnlyDoors: {
                    accepted: string[];
                    passwordAloneDoors: string[];
                    refused: string[];
                    secondFactor: boolean;
                    sentence: string;
                };
                passwordResetLink: { expired: boolean; expires: any };
                policy: {
                    backupCodesCount: number;
                    backupCodesEnabled: boolean;
                    maxKeysPerPerson: any;
                    mfaAllowed: boolean;
                    primaryAllowed: boolean;
                    totpEnabled: boolean;
                    webauthnEnabled: boolean;
                };
                primaryKeys: number;
                secondFactor: string;
                totp: boolean;
                totpDetail: {
                    algorithm: any;
                    digits: any;
                    enrolledAt: any;
                    lastUsedAt: any;
                    period: any;
                    sealed: boolean;
                    unusable: boolean;
                    why: any;
                };
                totpUsable: boolean;
                usable: boolean;
            };
            federationLinks: any;
            federationLinksPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            gnapGrants: any;
            gnapGrantsCells: any;
            gnapGrantsPaging: any;
            kerberos: any;
            ldap: any;
            risk: any;
            sessions: any;
            sessionsPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            subject: string;
            tokensOnEndedSessions: any;
            tokensOnEndedSessionsPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            tokensWithNoSession: any;
            tokensWithNoSessionPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            user: any;
        }
        | { known: boolean; user: string }

  • Builds /admin/users's JSON: the list, or one person.

    Parameters

    • req: any

      the request

    • Optionalrisk: any

      the person's risk standing, for the drill-down

    Returns
        | {
            authenticatedHere: number;
            capped: boolean;
            factors: {
                noCredential: number;
                passwordOnly: number;
                primaryKeys: number;
                unreadable: number;
                withKeys: number;
                withSecond: number;
                withTotp: number;
            };
            filter: { factor: string; protocol: string; q: string };
            firstRow: number;
            known: number;
            lastRow: number;
            matched: number;
            page: number;
            pages: number;
            perPage: number;
            protocols: string[];
            registryCap: number;
            scanLimit: number;
            scanned: number;
            shown: any;
            store: boolean;
            users: any;
        }
        | { known: boolean } & {
            artifacts: any;
            artifactsPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            attributeEditor: {
                attributes: (
                    EditableRow & { editable: boolean; values: string[]; why: string }
                )[];
                dn: string;
                mail: string;
                withheld: Withheld[];
            };
            credentials: any;
            factors: {
                activated: boolean;
                appPasswords: any;
                backupCodes: | {
                    generatedAt: number;
                    hashed?: undefined;
                    lastUsedAt: number;
                    legacy?: undefined;
                    present: boolean;
                    remaining: number;
                    sealed: boolean;
                    total: number;
                    usable: boolean;
                    used: number;
                    why: string;
                }
                | {
                    generatedAt: number;
                    hashed: boolean;
                    lastUsedAt: number;
                    legacy: boolean;
                    present: boolean;
                    remaining: number;
                    sealed: boolean;
                    total: number;
                    usable: boolean;
                    used: number;
                    why: string;
                };
                disabled: boolean;
                keys: {
                    aaguid: any;
                    algorithm: {
                        coseAlg: number;
                        insecure: boolean;
                        name: string;
                        postQuantum: boolean;
                        text: string;
                    };
                    attestation: any;
                    credentialId: any;
                    enrolledAt: any;
                    label: any;
                    role: any;
                    signCount: any;
                }[];
                mfaKeys: number;
                mfaRequired: boolean;
                mfaRequirement: | {
                    byAdministrator: boolean;
                    byRealm: boolean;
                    byUser: boolean;
                    offered: boolean;
                    required: boolean;
                }
                | { byRealm: false; byUser: false; required: false };
                password: boolean;
                passwordChangeRequired: boolean;
                passwordOnlyDoors: {
                    accepted: string[];
                    passwordAloneDoors: string[];
                    refused: string[];
                    secondFactor: boolean;
                    sentence: string;
                };
                passwordResetLink: { expired: boolean; expires: any };
                policy: {
                    backupCodesCount: number;
                    backupCodesEnabled: boolean;
                    maxKeysPerPerson: any;
                    mfaAllowed: boolean;
                    primaryAllowed: boolean;
                    totpEnabled: boolean;
                    webauthnEnabled: boolean;
                };
                primaryKeys: number;
                secondFactor: string;
                totp: boolean;
                totpDetail: {
                    algorithm: any;
                    digits: any;
                    enrolledAt: any;
                    lastUsedAt: any;
                    period: any;
                    sealed: boolean;
                    unusable: boolean;
                    why: any;
                };
                totpUsable: boolean;
                usable: boolean;
            };
            federationLinks: any;
            federationLinksPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            gnapGrants: any;
            gnapGrantsCells: any;
            gnapGrantsPaging: any;
            kerberos: any;
            ldap: any;
            risk: any;
            sessions: any;
            sessionsPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            subject: string;
            tokensOnEndedSessions: any;
            tokensOnEndedSessionsPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            tokensWithNoSession: any;
            tokensWithNoSessionPaging: {
                firstRow: any;
                lastRow: any;
                page: any;
                pages: any;
                perPage: any;
                total: any;
            };
            user: any;
        }
        | { known: boolean; user: string }

    the JSON