Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Lxd Provider
  4. API Docs
  5. getAuthGroup
Viewing docs for lxd 3.1.1
published on Thursday, Oct 1, 2026 by terraform-lxd
Schema (JSON)
terraform-lxd/terraform-provider-lxd

lxd.getAuthGroup

lxd
Viewing docs for lxd 3.1.1
published on Thursday, Oct 1, 2026 by terraform-lxd
Schema (JSON)
terraform-lxd/terraform-provider-lxd

    # lxd.AuthGroup

    Provides information about an existing LXD authorization group.

    Example Usage

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

const group = lxd.getAuthGroup({
    name: "admins",
});

    import pulumi
import pulumi_lxd as lxd

group = lxd.get_auth_group(name="admins")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/lxd/v3/lxd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lxd.LookupAuthGroup(ctx, &lxd.LookupAuthGroupArgs{
			Name: "admins",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Lxd = Pulumi.Lxd;

return await Deployment.RunAsync(() => 
{
    var @group = Lxd.GetAuthGroup.Invoke(new()
    {
        Name = "admins",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.lxd.LxdFunctions;
import com.pulumi.lxd.inputs.GetAuthGroupArgs;
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 group = LxdFunctions.getAuthGroup(GetAuthGroupArgs.builder()
            .name("admins")
            .build());

    }
}

    variables:
  group:
    fn::invoke:
      function: lxd:getAuthGroup
      arguments:
        name: admins

    Example coming soon!

    Using getAuthGroup

    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 getAuthGroup(args: GetAuthGroupArgs, opts?: InvokeOptions): Promise<GetAuthGroupResult>
function getAuthGroupOutput(args: GetAuthGroupOutputArgs, opts?: InvokeOutputOptions): Output<GetAuthGroupResult>
    def get_auth_group(name: Optional[str] = None,
                   remote: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAuthGroupResult
def get_auth_group_output(name: pulumi.Input[Optional[str]] = None,
                   remote: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetAuthGroupResult]
    func LookupAuthGroup(ctx *Context, args *LookupAuthGroupArgs, opts ...InvokeOption) (*LookupAuthGroupResult, error)
func LookupAuthGroupOutput(ctx *Context, args *LookupAuthGroupOutputArgs, opts ...InvokeOption) LookupAuthGroupResultOutput

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

    public static class GetAuthGroup 
{
    public static Task<GetAuthGroupResult> InvokeAsync(GetAuthGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthGroupResult> Invoke(GetAuthGroupInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthGroupResult> Invoke(GetAuthGroupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetAuthGroupResult> getAuthGroup(GetAuthGroupArgs args, InvokeOptions options)
public static Output<GetAuthGroupResult> getAuthGroup(GetAuthGroupArgs args, InvokeOptions options)
public static Output<GetAuthGroupResult> getAuthGroup(GetAuthGroupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: lxd:index/getAuthGroup:getAuthGroup
  arguments:
    # arguments dictionary
    data "lxd_get_auth_group" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Required - Name of the group.
    Remote string
    Optional - The remote from which the group is retrieved. If not provided, the provider's default remote is used.
    Name string
    Required - Name of the group.
    Remote string
    Optional - The remote from which the group is retrieved. If not provided, the provider's default remote is used.
    name string
    Required - Name of the group.
    remote string
    Optional - The remote from which the group is retrieved. If not provided, the provider's default remote is used.
    name String
    Required - Name of the group.
    remote String
    Optional - The remote from which the group is retrieved. If not provided, the provider's default remote is used.
    name string
    Required - Name of the group.
    remote string
    Optional - The remote from which the group is retrieved. If not provided, the provider's default remote is used.
    name str
    Required - Name of the group.
    remote str
    Optional - The remote from which the group is retrieved. If not provided, the provider's default remote is used.
    name String
    Required - Name of the group.
    remote String
    Optional - The remote from which the group is retrieved. If not provided, the provider's default remote is used.

    getAuthGroup Result

    The following output properties are available:

    Description string
    Description of the group.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderGroups List<string>
    List of identity provider group names that are mapped to the group.
    Name string
    Permissions List<GetAuthGroupPermission>
    List of group permissions.
    Remote string
    Description string
    Description of the group.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderGroups []string
    List of identity provider group names that are mapped to the group.
    Name string
    Permissions []GetAuthGroupPermission
    List of group permissions.
    Remote string
    description string
    Description of the group.
    id string
    The provider-assigned unique ID for this managed resource.
    identity_provider_groups list(string)
    List of identity provider group names that are mapped to the group.
    name string
    permissions list(object)
    List of group permissions.
    remote string
    description String
    Description of the group.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderGroups List<String>
    List of identity provider group names that are mapped to the group.
    name String
    permissions List<GetAuthGroupPermission>
    List of group permissions.
    remote String
    description string
    Description of the group.
    id string
    The provider-assigned unique ID for this managed resource.
    identityProviderGroups string[]
    List of identity provider group names that are mapped to the group.
    name string
    permissions GetAuthGroupPermission[]
    List of group permissions.
    remote string
    description str
    Description of the group.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_provider_groups Sequence[str]
    List of identity provider group names that are mapped to the group.
    name str
    permissions Sequence[GetAuthGroupPermission]
    List of group permissions.
    remote str
    description String
    Description of the group.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderGroups List<String>
    List of identity provider group names that are mapped to the group.
    name String
    permissions List<Property Map>
    List of group permissions.
    remote String

    Supporting Types

    GetAuthGroupPermission

    Entitlement string
    EntityArgs Dictionary<string, string>
    EntityType string
    Entitlement string
    EntityArgs map[string]string
    EntityType string
    entitlement string
    entity_args map(string)
    entity_type string
    entitlement String
    entityArgs Map<String,String>
    entityType String
    entitlement string
    entityArgs {[key: string]: string}
    entityType string
    entitlement str
    entity_args Mapping[str, str]
    entity_type str
    entitlement String
    entityArgs Map<String>
    entityType String

    Package Details

    Repository
    lxd terraform-lxd/terraform-provider-lxd
    License
    Notes
    This Pulumi package is based on the lxd Terraform Provider.
    lxd
    Viewing docs for lxd 3.1.1
    published on Thursday, Oct 1, 2026 by terraform-lxd
    Schema (JSON)
    terraform-lxd/terraform-provider-lxd

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial