Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. getGroup
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.getGroup

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

Get groups by pk or name

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";

const admins = authentik.getGroup({
    name: "authentik Admins",
});
Copy
import pulumi
import pulumi_authentik as authentik

admins = authentik.get_group(name="authentik Admins")
Copy
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.LookupGroup(ctx, &authentik.LookupGroupArgs{
			Name: pulumi.StringRef("authentik Admins"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var admins = Authentik.GetGroup.Invoke(new()
    {
        Name = "authentik Admins",
    });

});
Copy
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.GetGroupArgs;
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 admins = AuthentikFunctions.getGroup(GetGroupArgs.builder()
            .name("authentik Admins")
            .build());

    }
}
Copy
variables:
  admins:
    fn::invoke:
      function: authentik:getGroup
      arguments:
        name: authentik Admins
Copy

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
Copy
def get_group(id: Optional[str] = None,
              include_users: Optional[bool] = None,
              name: Optional[str] = None,
              pk: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(id: Optional[pulumi.Input[str]] = None,
              include_users: Optional[pulumi.Input[bool]] = None,
              name: Optional[pulumi.Input[str]] = None,
              pk: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
Copy
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
Copy

> Note: This function is named LookupGroup in the Go SDK.

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: authentik:index/getGroup:getGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The ID of this resource.
IncludeUsers bool
Name string
Pk string
Id string
The ID of this resource.
IncludeUsers bool
Name string
Pk string
id String
The ID of this resource.
includeUsers Boolean
name String
pk String
id string
The ID of this resource.
includeUsers boolean
name string
pk string
id str
The ID of this resource.
include_users bool
name str
pk str
id String
The ID of this resource.
includeUsers Boolean
name String
pk String

getGroup Result

The following output properties are available:

Attributes string
Generated.
Id string
The ID of this resource.
IsSuperuser bool
Generated.
NumPk double
Generated.
Parent string
Generated.
ParentName string
Generated.
Users List<double>
Generated.
UsersObjs List<GetGroupUsersObj>
Generated.
IncludeUsers bool
Name string
Pk string
Attributes string
Generated.
Id string
The ID of this resource.
IsSuperuser bool
Generated.
NumPk float64
Generated.
Parent string
Generated.
ParentName string
Generated.
Users []float64
Generated.
UsersObjs []GetGroupUsersObj
Generated.
IncludeUsers bool
Name string
Pk string
attributes String
Generated.
id String
The ID of this resource.
isSuperuser Boolean
Generated.
numPk Double
Generated.
parent String
Generated.
parentName String
Generated.
users List<Double>
Generated.
usersObjs List<GetGroupUsersObj>
Generated.
includeUsers Boolean
name String
pk String
attributes string
Generated.
id string
The ID of this resource.
isSuperuser boolean
Generated.
numPk number
Generated.
parent string
Generated.
parentName string
Generated.
users number[]
Generated.
usersObjs GetGroupUsersObj[]
Generated.
includeUsers boolean
name string
pk string
attributes str
Generated.
id str
The ID of this resource.
is_superuser bool
Generated.
num_pk float
Generated.
parent str
Generated.
parent_name str
Generated.
users Sequence[float]
Generated.
users_objs Sequence[GetGroupUsersObj]
Generated.
include_users bool
name str
pk str
attributes String
Generated.
id String
The ID of this resource.
isSuperuser Boolean
Generated.
numPk Number
Generated.
parent String
Generated.
parentName String
Generated.
users List<Number>
Generated.
usersObjs List<Property Map>
Generated.
includeUsers Boolean
name String
pk String

Supporting Types

GetGroupUsersObj

Attributes This property is required. string
Email This property is required. string
IsActive This property is required. bool
LastLogin This property is required. string
Name This property is required. string
Pk This property is required. double
Uid This property is required. string
Username This property is required. string
Attributes This property is required. string
Email This property is required. string
IsActive This property is required. bool
LastLogin This property is required. string
Name This property is required. string
Pk This property is required. float64
Uid This property is required. string
Username This property is required. string
attributes This property is required. String
email This property is required. String
isActive This property is required. Boolean
lastLogin This property is required. String
name This property is required. String
pk This property is required. Double
uid This property is required. String
username This property is required. String
attributes This property is required. string
email This property is required. string
isActive This property is required. boolean
lastLogin This property is required. string
name This property is required. string
pk This property is required. number
uid This property is required. string
username This property is required. string
attributes This property is required. str
email This property is required. str
is_active This property is required. bool
last_login This property is required. str
name This property is required. str
pk This property is required. float
uid This property is required. str
username This property is required. str
attributes This property is required. String
email This property is required. String
isActive This property is required. Boolean
lastLogin This property is required. String
name This property is required. String
pk This property is required. Number
uid This property is required. String
username This property is required. String

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik