List Users

List and query users. You can search for users by combining various query parameters.

External Documentation

To learn more, visit the Authentik documentation.

Basic Parameters

Parameter	Description
Name	Query by the name of the user.
User Type	Query by the type of the user.
Username	Query by the username of the user.

Advanced Parameters

Parameter	Description
Attributes	Query by the additional attributes of the user.
Email	Query by the email of the user.
Group IDs	Query by a comma seperated list of the user's groups. Can be obtained by the List Groups action.
Group Names	Query by a comma seperated list of the user's groups. Can be obtained by the List Groups action.
Include Groups	Include the user's groups in the response.
Is Active	Query by if the user active.
Is Superuser	Query by if the user is a superuser.
Order By	Which field to use when ordering the results.
Page Number	The page number being requested.
Page Size	Number of results to return per page.
Search	A search term.
UUID	Query by the UUID of the user.
User Path	Query by the path of the user.
User Path Starts With	Query by the path of the user.

Example Output

{
    "pagination": {
        "count": 0,
        "current": 0,
        "end_index": 0,
        "next": 0,
        "previous": 0,
        "start_index": 0,
        "total_pages": 0
    },
    "results": [
        {
            "attributes": {},
            "avatar": "User's avatar, either a http/https URL or a data URI",
            "email": "Email address",
            "groups": [
                "uuid"
            ],
            "groups_obj": [
                {
                    "attributes": {},
                    "is_superuser": false,
                    "name": "string",
                    "num_pk": 0,
                    "parent": "uuid",
                    "parent_name": "string",
                    "pk": "Group uuid"
                }
            ],
            "is_active": false,
            "is_superuser": false,
            "last_login": "date-time",
            "name": "User's display name.",
            "path": "string",
            "pk": 0,
            "type": "string",
            "uid": "string",
            "username": "string",
            "uuid": "uuid"
        }
    ]
}

Workflow Library Example

List Users with Authentik and Send Results Via Email

Preview this Workflow on desktop