List Groups

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

External Documentation

To learn more, visit the Authentik documentation.

Basic Parameters

Parameter	Description
Group Name	Query by the name of the group.
Members By Username	Query by a comma separated list of the group's member usernames. Can be obtained by the List Users action.

Advanced Parameters

Parameter	Description
Attributes	Query by the additional attributes.
Include Users	Include the group's users in the response.
Is Superuser	Is the group designated as a superuser group.
Members By ID	Query by a comma separated list of the group's member IDs. Can be obtained by the List Users action.
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.

Example Output

{
    "pagination": {
        "count": 0,
        "current": 0,
        "end_index": 0,
        "next": 0,
        "previous": 0,
        "start_index": 0,
        "total_pages": 0
    },
    "results": [
        {
            "attributes": {},
            "is_superuser": false,
            "name": "string",
            "num_pk": 0,
            "parent": "uuid",
            "parent_name": "string",
            "pk": "Group uuid",
            "roles": [
                "uuid"
            ],
            "roles_obj": [
                {
                    "name": "string",
                    "pk": "Uuid"
                }
            ],
            "users": [
                0
            ],
            "users_obj": [
                {
                    "attributes": {},
                    "email": "Email address",
                    "is_active": false,
                    "last_login": "date-time",
                    "name": "User's display name.",
                    "pk": 0,
                    "uid": "string",
                    "username": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only."
                }
            ]
        }
    ]
}

Workflow Library Example

List Groups with Authentik and Send Results Via Email

Preview this Workflow on desktop