To learn more, visit the Authentik documentation.

​
Basic Parameters​

ParameterDescription
NameQuery by the name of the user.
User TypeQuery by the type of the user.
UsernameQuery by the username of the user.

​
Advanced Parameters​

ParameterDescription
AttributesQuery by the additional attributes of the user.
EmailQuery by the email of the user.
Group IDsQuery by a comma separated list of the user’s groups. Can be obtained by the List Groups action.
Group NamesQuery by a comma separated list of the user’s groups. Can be obtained by the List Groups action.
Include GroupsInclude the user’s groups in the response.
Is ActiveQuery by if the user active.
Is SuperuserQuery by if the user is a superuser.
Order ByWhich field to use when ordering the results.
Page NumberThe page number being requested.
Page SizeNumber of results to return per page.
SearchA search term.
UUIDQuery by the UUID of the user.
User PathQuery by the path of the user.
User Path Starts WithQuery 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

List GroupsRemove User From Group