authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
authentik.getGroups
authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
Get groups list
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";
const all = authentik.getGroups({});
const admins = authentik.getGroups({
isSuperuser: true,
});
import pulumi
import pulumi_authentik as authentik
all = authentik.get_groups()
admins = authentik.get_groups(is_superuser=True)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := authentik.GetGroups(ctx, &authentik.GetGroupsArgs{}, nil)
if err != nil {
return err
}
_, err = authentik.GetGroups(ctx, &authentik.GetGroupsArgs{
IsSuperuser: pulumi.BoolRef(true),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;
return await Deployment.RunAsync(() =>
{
var all = Authentik.GetGroups.Invoke();
var admins = Authentik.GetGroups.Invoke(new()
{
IsSuperuser = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.AuthentikFunctions;
import com.pulumi.authentik.inputs.GetGroupsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var all = AuthentikFunctions.getGroups();
final var admins = AuthentikFunctions.getGroups(GetGroupsArgs.builder()
.isSuperuser(true)
.build());
}
}
variables:
all:
fn::invoke:
function: authentik:getGroups
arguments: {}
admins:
fn::invoke:
function: authentik:getGroups
arguments:
isSuperuser: true
Using getGroups
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>def get_groups(attributes: Optional[str] = None,
id: Optional[str] = None,
include_users: Optional[bool] = None,
is_superuser: Optional[bool] = None,
members_by_pks: Optional[Sequence[float]] = None,
members_by_usernames: Optional[Sequence[str]] = None,
name: Optional[str] = None,
ordering: Optional[str] = None,
search: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(attributes: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
include_users: Optional[pulumi.Input[bool]] = None,
is_superuser: Optional[pulumi.Input[bool]] = None,
members_by_pks: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
members_by_usernames: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name: Optional[pulumi.Input[str]] = None,
ordering: Optional[pulumi.Input[str]] = None,
search: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput> Note: This function is named GetGroups in the Go SDK.
public static class GetGroups
{
public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
fn::invoke:
function: authentik:index/getGroups:getGroups
arguments:
# arguments dictionaryThe following arguments are supported:
- Attributes string
- Id string
- The ID of this resource.
- Include
Users bool - Is
Superuser bool - Members
By List<double>Pks - Members
By List<string>Usernames - Name string
- Ordering string
- Search string
- Attributes string
- Id string
- The ID of this resource.
- Include
Users bool - Is
Superuser bool - Members
By []float64Pks - Members
By []stringUsernames - Name string
- Ordering string
- Search string
- attributes String
- id String
- The ID of this resource.
- include
Users Boolean - is
Superuser Boolean - members
By List<Double>Pks - members
By List<String>Usernames - name String
- ordering String
- search String
- attributes string
- id string
- The ID of this resource.
- include
Users boolean - is
Superuser boolean - members
By number[]Pks - members
By string[]Usernames - name string
- ordering string
- search string
- attributes str
- id str
- The ID of this resource.
- include_
users bool - is_
superuser bool - members_
by_ Sequence[float]pks - members_
by_ Sequence[str]usernames - name str
- ordering str
- search str
- attributes String
- id String
- The ID of this resource.
- include
Users Boolean - is
Superuser Boolean - members
By List<Number>Pks - members
By List<String>Usernames - name String
- ordering String
- search String
getGroups Result
The following output properties are available:
- Groups
List<Get
Groups Group> - Generated.
- Id string
- The ID of this resource.
- Attributes string
- Include
Users bool - Is
Superuser bool - Members
By List<double>Pks - Members
By List<string>Usernames - Name string
- Ordering string
- Search string
- Groups
[]Get
Groups Group - Generated.
- Id string
- The ID of this resource.
- Attributes string
- Include
Users bool - Is
Superuser bool - Members
By []float64Pks - Members
By []stringUsernames - Name string
- Ordering string
- Search string
- groups
List<Get
Groups Group> - Generated.
- id String
- The ID of this resource.
- attributes String
- include
Users Boolean - is
Superuser Boolean - members
By List<Double>Pks - members
By List<String>Usernames - name String
- ordering String
- search String
- groups
Get
Groups Group[] - Generated.
- id string
- The ID of this resource.
- attributes string
- include
Users boolean - is
Superuser boolean - members
By number[]Pks - members
By string[]Usernames - name string
- ordering string
- search string
- groups
Sequence[Get
Groups Group] - Generated.
- id str
- The ID of this resource.
- attributes str
- include_
users bool - is_
superuser bool - members_
by_ Sequence[float]pks - members_
by_ Sequence[str]usernames - name str
- ordering str
- search str
- groups List<Property Map>
- Generated.
- id String
- The ID of this resource.
- attributes String
- include
Users Boolean - is
Superuser Boolean - members
By List<Number>Pks - members
By List<String>Usernames - name String
- ordering String
- search String
Supporting Types
GetGroupsGroup
- Attributes string
- Is
Superuser bool - Name string
- Num
Pk double - Parent string
- Parent
Name string - Pk string
- Users List<double>
- Users
Objs List<GetGroups Group Users Obj>
- Attributes string
- Is
Superuser bool - Name string
- Num
Pk float64 - Parent string
- Parent
Name string - Pk string
- Users []float64
- Users
Objs []GetGroups Group Users Obj
- attributes String
- is
Superuser Boolean - name String
- num
Pk Double - parent String
- parent
Name String - pk String
- users List<Double>
- users
Objs List<GetGroups Group Users Obj>
- attributes string
- is
Superuser boolean - name string
- num
Pk number - parent string
- parent
Name string - pk string
- users number[]
- users
Objs GetGroups Group Users Obj[]
- attributes str
- is_
superuser bool - name str
- num_
pk float - parent str
- parent_
name str - pk str
- users Sequence[float]
- users_
objs Sequence[GetGroups Group Users Obj]
- attributes String
- is
Superuser Boolean - name String
- num
Pk Number - parent String
- parent
Name String - pk String
- users List<Number>
- users
Objs List<Property Map>
GetGroupsGroupUsersObj
- attributes str
- email str
- is_
active bool - last_
login str - name str
- pk float
- uid str
- username str
Package Details
- Repository
- authentik goauthentik/terraform-provider-authentik
- License
- Notes
- This Pulumi package is based on the
authentikTerraform Provider.
authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
