1. Packages
  2. Lxd Provider
  3. API Docs
  4. getAuthIdentity
Viewing docs for lxd 2.7.0
published on Friday, Feb 27, 2026 by terraform-lxd
lxd logo
Viewing docs for lxd 2.7.0
published on Friday, Feb 27, 2026 by terraform-lxd

    #<span pulumi-lang-nodejs=" lxd.AuthIdentity

    " pulumi-lang-dotnet=" lxd.AuthIdentity " pulumi-lang-go=" AuthIdentity " pulumi-lang-python=" AuthIdentity " pulumi-lang-yaml=" lxd.AuthIdentity " pulumi-lang-java=" lxd.AuthIdentity “> lxd.AuthIdentity Provides information about an existing LXD identity.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as lxd from "@pulumi/lxd";
    
    const id = lxd.getAuthIdentity({
        authMethod: "bearer",
        name: "my-identity",
    });
    
    import pulumi
    import pulumi_lxd as lxd
    
    id = lxd.get_auth_identity(auth_method="bearer",
        name="my-identity")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/lxd/v2/lxd"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := lxd.LookupAuthIdentity(ctx, &lxd.LookupAuthIdentityArgs{
    			AuthMethod: "bearer",
    			Name:       "my-identity",
    		}, 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 id = Lxd.GetAuthIdentity.Invoke(new()
        {
            AuthMethod = "bearer",
            Name = "my-identity",
        });
    
    });
    
    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.GetAuthIdentityArgs;
    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 id = LxdFunctions.getAuthIdentity(GetAuthIdentityArgs.builder()
                .authMethod("bearer")
                .name("my-identity")
                .build());
    
        }
    }
    
    variables:
      id:
        fn::invoke:
          function: lxd:getAuthIdentity
          arguments:
            authMethod: bearer
            name: my-identity
    

    Using getAuthIdentity

    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 getAuthIdentity(args: GetAuthIdentityArgs, opts?: InvokeOptions): Promise<GetAuthIdentityResult>
    function getAuthIdentityOutput(args: GetAuthIdentityOutputArgs, opts?: InvokeOptions): Output<GetAuthIdentityResult>
    def get_auth_identity(auth_method: Optional[str] = None,
                          name: Optional[str] = None,
                          remote: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAuthIdentityResult
    def get_auth_identity_output(auth_method: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          remote: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAuthIdentityResult]
    func LookupAuthIdentity(ctx *Context, args *LookupAuthIdentityArgs, opts ...InvokeOption) (*LookupAuthIdentityResult, error)
    func LookupAuthIdentityOutput(ctx *Context, args *LookupAuthIdentityOutputArgs, opts ...InvokeOption) LookupAuthIdentityResultOutput

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

    public static class GetAuthIdentity 
    {
        public static Task<GetAuthIdentityResult> InvokeAsync(GetAuthIdentityArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthIdentityResult> Invoke(GetAuthIdentityInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthIdentityResult> getAuthIdentity(GetAuthIdentityArgs args, InvokeOptions options)
    public static Output<GetAuthIdentityResult> getAuthIdentity(GetAuthIdentityArgs args, InvokeOptions options)
    
    fn::invoke:
      function: lxd:index/getAuthIdentity:getAuthIdentity
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AuthMethod string
    Required - Authentication method, can be either tls, bearer, or oidc.
    Name string
    Required - Name of the identity.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    AuthMethod string
    Required - Authentication method, can be either tls, bearer, or oidc.
    Name string
    Required - Name of the identity.
    Remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    authMethod String
    Required - Authentication method, can be either tls, bearer, or oidc.
    name String
    Required - Name of the identity.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    authMethod string
    Required - Authentication method, can be either tls, bearer, or oidc.
    name string
    Required - Name of the identity.
    remote string
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    auth_method str
    Required - Authentication method, can be either tls, bearer, or oidc.
    name str
    Required - Name of the identity.
    remote str
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
    authMethod String
    Required - Authentication method, can be either tls, bearer, or oidc.
    name String
    Required - Name of the identity.
    remote String
    Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

    getAuthIdentity Result

    The following output properties are available:

    AuthMethod string
    Groups List<string>
    List of group names the identity is part of.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Identity ID.
    Name string
    TlsCertificate string
    PEM encoded x509 certificate. Populated only for TLS identities.
    Remote string
    AuthMethod string
    Groups []string
    List of group names the identity is part of.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Identity ID.
    Name string
    TlsCertificate string
    PEM encoded x509 certificate. Populated only for TLS identities.
    Remote string
    authMethod String
    groups List<String>
    List of group names the identity is part of.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Identity ID.
    name String
    tlsCertificate String
    PEM encoded x509 certificate. Populated only for TLS identities.
    remote String
    authMethod string
    groups string[]
    List of group names the identity is part of.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Identity ID.
    name string
    tlsCertificate string
    PEM encoded x509 certificate. Populated only for TLS identities.
    remote string
    auth_method str
    groups Sequence[str]
    List of group names the identity is part of.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Identity ID.
    name str
    tls_certificate str
    PEM encoded x509 certificate. Populated only for TLS identities.
    remote str
    authMethod String
    groups List<String>
    List of group names the identity is part of.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Identity ID.
    name String
    tlsCertificate String
    PEM encoded x509 certificate. Populated only for TLS identities.
    remote String

    Package Details

    Repository
    lxd terraform-lxd/terraform-provider-lxd
    License
    Notes
    This Pulumi package is based on the lxd Terraform Provider.
    lxd logo
    Viewing docs for lxd 2.7.0
    published on Friday, Feb 27, 2026 by terraform-lxd
      Try Pulumi Cloud free. Your team will thank you.