To learn more, visit the Authentik documentation.

​
Basic Parameters​

ParameterDescription
Group NameQuery by the name of the group.
Members By UsernameQuery by a comma separated list of the group’s member usernames. Can be obtained by the List Users action.

​
Advanced Parameters​

ParameterDescription
AttributesQuery by the additional attributes.
Include UsersInclude the group’s users in the response.
Is SuperuserIs the group designated as a superuser group.
Members By IDQuery by a comma separated list of the group’s member IDs. Can be obtained by the List Users action.
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.

​
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

Get UserList Users