authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
authentik.getGroup
Explore with Pulumi AI
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
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",
});
import pulumi
import pulumi_authentik as authentik
admins = authentik.get_group(name="authentik Admins")
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
})
}
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",
});
});
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());
}
}
variables:
admins:
fn::invoke:
function: authentik:getGroup
arguments:
name: authentik Admins
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>
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]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
> 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)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
fn::invoke:
function: authentik:index/getGroup:getGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- The ID of this resource.
- Include
Users bool - Name string
- Pk string
- Id string
- The ID of this resource.
- Include
Users bool - Name string
- Pk string
- id String
- The ID of this resource.
- include
Users Boolean - name String
- pk String
- id string
- The ID of this resource.
- include
Users 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.
- include
Users Boolean - name String
- pk String
getGroup Result
The following output properties are available:
- Attributes string
- Generated.
- Id string
- The ID of this resource.
- Is
Superuser bool - Generated.
- Num
Pk double - Generated.
- Parent string
- Generated.
- Parent
Name string - Generated.
- Users List<double>
- Generated.
- Users
Objs List<GetGroup Users Obj> - Generated.
- Include
Users bool - Name string
- Pk string
- Attributes string
- Generated.
- Id string
- The ID of this resource.
- Is
Superuser bool - Generated.
- Num
Pk float64 - Generated.
- Parent string
- Generated.
- Parent
Name string - Generated.
- Users []float64
- Generated.
- Users
Objs []GetGroup Users Obj - Generated.
- Include
Users bool - Name string
- Pk string
- attributes String
- Generated.
- id String
- The ID of this resource.
- is
Superuser Boolean - Generated.
- num
Pk Double - Generated.
- parent String
- Generated.
- parent
Name String - Generated.
- users List<Double>
- Generated.
- users
Objs List<GetGroup Users Obj> - Generated.
- include
Users Boolean - name String
- pk String
- attributes string
- Generated.
- id string
- The ID of this resource.
- is
Superuser boolean - Generated.
- num
Pk number - Generated.
- parent string
- Generated.
- parent
Name string - Generated.
- users number[]
- Generated.
- users
Objs GetGroup Users Obj[] - Generated.
- include
Users 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[GetGroup Users Obj] - Generated.
- include_
users bool - name str
- pk str
- attributes String
- Generated.
- id String
- The ID of this resource.
- is
Superuser Boolean - Generated.
- num
Pk Number - Generated.
- parent String
- Generated.
- parent
Name String - Generated.
- users List<Number>
- Generated.
- users
Objs List<Property Map> - Generated.
- include
Users Boolean - name String
- pk String
Supporting Types
GetGroupUsersObj
- 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
authentik
Terraform Provider.
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik