@karmaniverous/aws-cognito-tools
    Preparing search index...

    Interface ListAllUsersOptions

    Options for AwsCognitoTools.listAllUsers.

    interface ListAllUsersOptions {
        filter?: string;
        maxPages?: number;
        maxResults?: number;
        onPage?: (users: UserType[], pageNumber: number) => void;
        userPoolId: string;
    }
    Index
    filter? maxPages? maxResults? onPage? userPoolId
    filter?: string

    Optional filter expression (Cognito ListUsers filter syntax).

    maxPages?: number

    Maximum number of pages to fetch. Safety valve against runaway requests.

    maxResults?: number

    Maximum total users to return. When reached, pagination stops.

    onPage?: (users: UserType[], pageNumber: number) => void

    Callback invoked after each page is fetched. Enables streaming/progress without full buffering.

    userPoolId: string

    User Pool ID.

    Settings
    Member Visibility

    On This Page
    Properties