AuthentikInstall

Summary

List users in Authentik, applying optional filters and pagination to refine results.

Inputs

• Page Size — Number of users to return per page (default 100).
• Page — Page number to retrieve (default 1).
• Search — Search term filtering users by username, name, or email.
• Email Filter — Filter users by exact email address.
• Username Filter — Filter users by exact username.
• Is Active — Filter users by active status (default true).
• Is Superuser — Filter users by superuser status (default false).
• Include Groups — Include group information in the response (default true).
• User Type Filter — Filter users by one or more user types (internal, external, service account, internal service account).
• Groups by Name — Comma-separated list of group names to filter users by.
• Groups by UUID — Comma-separated list of group UUIDs to filter users by.
• Name Filter — Filter users by exact display name.
• Path Filter — Filter users by exact user path.
• Path Starts With — Filter users whose path starts with given value.
• UUID Filter — Filter users by user UUID.
• Attributes Filter — Filter users by attributes specified as a JSON string.
• Ordering — Order results by specified field, e.g., username, name, email, date joined, or last login, with ascending or descending options.

Output shape

a single JSON object containing a list of users matching the applied filters, including pagination details.

The output includes user records with optional group information if "Include Groups" is set. Pagination is controlled by "Page Size" and "Page" parameters. Filters are combined to narrow user listings. If no filters are applied, the operation returns the first page of users ordered by username ascending by default.