Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Lxd Provider
  4. API Docs
  5. AuthIdentityProviderGroup
Viewing docs for lxd 3.1.0
published on Tuesday, Sep 15, 2026 by terraform-lxd
Schema (JSON)
terraform-lxd/terraform-provider-lxd

lxd.AuthIdentityProviderGroup

Viewing docs for lxd 3.1.0
published on Tuesday, Sep 15, 2026 by terraform-lxd
Schema (JSON)
terraform-lxd/terraform-provider-lxd

    # lxd.AuthIdentityProviderGroup

    Manages a LXD identity provider group, which maps a group defined by the identity provider to LXD authorization groups.

    Example Usage

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

const viewers = new lxd.AuthGroup("viewers", {
    name: "viewers",
    permissions: [{
        entitlement: "viewer",
        entityType: "server",
    }],
});
const viewersAuthIdentityProviderGroup = new lxd.AuthIdentityProviderGroup("viewers", {
    name: "viewers",
    groups: [viewers.name],
});

    import pulumi
import pulumi_lxd as lxd

viewers = lxd.AuthGroup("viewers",
    name="viewers",
    permissions=[{
        "entitlement": "viewer",
        "entity_type": "server",
    }])
viewers_auth_identity_provider_group = lxd.AuthIdentityProviderGroup("viewers",
    name="viewers",
    groups=[viewers.name])

    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 {
		viewers, err := lxd.NewAuthGroup(ctx, "viewers", &lxd.AuthGroupArgs{
			Name: pulumi.String("viewers"),
			Permissions: lxd.AuthGroupPermissionArray{
				&lxd.AuthGroupPermissionArgs{
					Entitlement: pulumi.String("viewer"),
					EntityType:  pulumi.String("server"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = lxd.NewAuthIdentityProviderGroup(ctx, "viewers", &lxd.AuthIdentityProviderGroupArgs{
			Name: pulumi.String("viewers"),
			Groups: pulumi.StringArray{
				viewers.Name,
			},
		})
		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 viewers = new Lxd.AuthGroup("viewers", new()
    {
        Name = "viewers",
        Permissions = new[]
        {
            new Lxd.Inputs.AuthGroupPermissionArgs
            {
                Entitlement = "viewer",
                EntityType = "server",
            },
        },
    });

    var viewersAuthIdentityProviderGroup = new Lxd.AuthIdentityProviderGroup("viewers", new()
    {
        Name = "viewers",
        Groups = new[]
        {
            viewers.Name,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.lxd.AuthGroup;
import com.pulumi.lxd.AuthGroupArgs;
import com.pulumi.lxd.inputs.AuthGroupPermissionArgs;
import com.pulumi.lxd.AuthIdentityProviderGroup;
import com.pulumi.lxd.AuthIdentityProviderGroupArgs;
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) {
        var viewers = new AuthGroup("viewers", AuthGroupArgs.builder()
            .name("viewers")
            .permissions(AuthGroupPermissionArgs.builder()
                .entitlement("viewer")
                .entityType("server")
                .build())
            .build());

        var viewersAuthIdentityProviderGroup = new AuthIdentityProviderGroup("viewersAuthIdentityProviderGroup", AuthIdentityProviderGroupArgs.builder()
            .name("viewers")
            .groups(viewers.name())
            .build());

    }
}

    resources:
  viewers:
    type: lxd:AuthGroup
    properties:
      name: viewers
      permissions:
        - entitlement: viewer
          entityType: server
  viewersAuthIdentityProviderGroup:
    type: lxd:AuthIdentityProviderGroup
    name: viewers
    properties:
      name: viewers
      groups:
        - ${viewers.name}

    Example coming soon!

    Create AuthIdentityProviderGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthIdentityProviderGroup(name: string, args?: AuthIdentityProviderGroupArgs, opts?: CustomResourceOptions);
    @overload
def AuthIdentityProviderGroup(resource_name: str,
                              args: Optional[AuthIdentityProviderGroupArgs] = None,
                              opts: Optional[ResourceOptions] = None)

@overload
def AuthIdentityProviderGroup(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              groups: Optional[Sequence[str]] = None,
                              name: Optional[str] = None,
                              remote: Optional[str] = None)
    func NewAuthIdentityProviderGroup(ctx *Context, name string, args *AuthIdentityProviderGroupArgs, opts ...ResourceOption) (*AuthIdentityProviderGroup, error)
    public AuthIdentityProviderGroup(string name, AuthIdentityProviderGroupArgs? args = null, CustomResourceOptions? opts = null)
    public AuthIdentityProviderGroup(String name, AuthIdentityProviderGroupArgs args)
public AuthIdentityProviderGroup(String name, AuthIdentityProviderGroupArgs args, CustomResourceOptions options)

    type: lxd:AuthIdentityProviderGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "lxd_auth_identity_provider_group" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AuthIdentityProviderGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthIdentityProviderGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthIdentityProviderGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthIdentityProviderGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthIdentityProviderGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var authIdentityProviderGroupResource = new Lxd.AuthIdentityProviderGroup("authIdentityProviderGroupResource", new()
{
    Groups = new[]
    {
        "string",
    },
    Name = "string",
    Remote = "string",
});

    example, err := lxd.NewAuthIdentityProviderGroup(ctx, "authIdentityProviderGroupResource", &lxd.AuthIdentityProviderGroupArgs{
	Groups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:   pulumi.String("string"),
	Remote: pulumi.String("string"),
})

    resource "lxd_auth_identity_provider_group" "authIdentityProviderGroupResource" {
  lifecycle {
    create_before_destroy = true
  }
  groups = ["string"]
  name   = "string"
  remote = "string"
}

    var authIdentityProviderGroupResource = new AuthIdentityProviderGroup("authIdentityProviderGroupResource", AuthIdentityProviderGroupArgs.builder()
    .groups("string")
    .name("string")
    .remote("string")
    .build());

    auth_identity_provider_group_resource = lxd.AuthIdentityProviderGroup("authIdentityProviderGroupResource",
    groups=["string"],
    name="string",
    remote="string")

    const authIdentityProviderGroupResource = new lxd.AuthIdentityProviderGroup("authIdentityProviderGroupResource", {
    groups: ["string"],
    name: "string",
    remote: "string",
});

    type: lxd:AuthIdentityProviderGroup
properties:
    groups:
        - string
    name: string
    remote: string

    AuthIdentityProviderGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AuthIdentityProviderGroup resource accepts the following input properties:

    Groups List<string>
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    Name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    Groups []string
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    Name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups list(string)
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups List<String>
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name String
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups string[]
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups Sequence[str]
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name str
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote str
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups List<String>
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name String
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthIdentityProviderGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthIdentityProviderGroup Resource

    Get an existing AuthIdentityProviderGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AuthIdentityProviderGroupState, opts?: CustomResourceOptions): AuthIdentityProviderGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        groups: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        remote: Optional[str] = None) -> AuthIdentityProviderGroup
    func GetAuthIdentityProviderGroup(ctx *Context, name string, id IDInput, state *AuthIdentityProviderGroupState, opts ...ResourceOption) (*AuthIdentityProviderGroup, error)
    public static AuthIdentityProviderGroup Get(string name, Input<string> id, AuthIdentityProviderGroupState? state, CustomResourceOptions? opts = null)
    public static AuthIdentityProviderGroup get(String name, Output<String> id, AuthIdentityProviderGroupState state, CustomResourceOptions options)
    resources:  _:    type: lxd:AuthIdentityProviderGroup    get:      id: ${id}
    import {
  to = lxd_auth_identity_provider_group.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Groups List<string>
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    Name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    Groups []string
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    Name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups list(string)
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups List<String>
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name String
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups string[]
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name string
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups Sequence[str]
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name str
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote str
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    groups List<String>
    Optional - List of authorization group names the identity provider group is mapped to. If not specified, the identity provider group is mapped to no authorization groups.
    name String
    Required - Name of the identity provider group, as it appears in the OIDC token claim.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

    Import

    ing

    This resource is imported using its resource identity.

    • name - Required - Identity provider group name.
    • remote - Optional - Remote name. If not provided, the provider’s default remote is used.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    lxd terraform-lxd/terraform-provider-lxd
    License
    Notes
    This Pulumi package is based on the lxd Terraform Provider.
    Viewing docs for lxd 3.1.0
    published on Tuesday, Sep 15, 2026 by terraform-lxd
    Schema (JSON)
    terraform-lxd/terraform-provider-lxd

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial